Skip to content

Conversation

@julian-cable
Copy link
Collaborator

Addresses these issues:
#24
#79
#364
#369
#373
#404
#406

@julian-cable
Copy link
Collaborator Author

@daobrien @nmuller66 @sffrench These style guide fixes are ready for review.

@julian-cable
Copy link
Collaborator Author

These fixes are for the upcoming October release 6.0 of the style guide.

Comment on lines 474 to 475
<entry> The <command>fsck</command> utility performs a file system verification on the XFS file system residing on the <filename>/dev/vdb1</filename> partition. </entry>
<entry> The <command>fsck</command> utility verifies the XFS file system on the <filename>/dev/vdb1</filename> partition. </entry>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example is much better (I've been meaning to fix this for ages) but it's also not quite accurate. If you run fsck with no args it checks all file systems on all devices. If you want to check a specific file system then you have to pass it as an arg. E.g., fsck /dev/hd1

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the command to include arguments.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@psweany or @bonnevil comment please?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small update to the example following Phil's feedback.

</row>
<row>
<entry> It is possible that the scheduled snapshot takes some time to be created. </entry>
<entry> Creating the scheduled snapshot might take time. </entry>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything takes time. Can we elaborate a bit? Something like "Creating the snapshot will take more or less time depending on the size of the system." Or maybe something different altogether?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replaced with a different example.

Copy link
Collaborator

@daobrien daobrien left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm ok with 99% of this but recommend @psweany or maybe @bonnevil review the example for fsck. I'd like to make sure it's a sound example.

Comment on lines 81 to 83
<!-- If you use DocBook or AsciiDoc to build itemized or ordered lists, you can choose between normal spacing or the <option>compact</option> attribute to specify the spacing between list items.
In AsciiDoc, compact spacing is not supported for variable (definition) lists.
DocBook and AsciiDoc use the <option>normal</option> spacing attribute by default.
<!-- In AsciiDoc? -->
DocBook and AsciiDoc use the <option>normal</option> spacing attribute by default. -->
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unless you have specific reason for keeping it, just delete this and similar content.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deleted

@daobrien daobrien requested review from bonnevil and psweany October 14, 2022 14:01
@daobrien daobrien merged commit 2048498 into dev Oct 18, 2022
@daobrien daobrien deleted the jcable/6.0-fixes branch October 18, 2022 01:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants