[LUDOC-273] update description of command tunefs.lustre to match mkfs.lustre in section SystemConfigurationUtilities

• Status: Closed
• Project: Lustre Documentation
• Type: Improvement
• Priority: Minor
• Reporter: Chris Hunter (Inactive)
• Assignee: Richard Henwood (Inactive)
• Resolution: Fixed
• Labels: e2fsprogs

Description

The default mkfs.lustre options changed to reflect changes in underlying ext4 filesystem (used by ldiskfs).

In the SystemConfigurationUtilities section of the manual, the description of "mkfs.lustre" has been already updated. This change will update description of tunefs.lustre by modifying "mountfsoptions" line.

Comments

[Richard Henwood (Inactive)]

Thanks for this Chris.

On the mailing list, you said you were 'slightly confounded by the "submit a patch"
part'

I'd like to improve our documentation - so can you advise where you got confounded?

[Gerrit Updater]

Richard Henwood ([e-mail]) uploaded a new patch: http://review.whamcloud.com/14481
Subject: LUDOC-273 tune: update tunefs.lustre
Project: doc/manual
Branch: master
Current Patch Set: 1
Commit: f424186fa6cd242de14ff61ed3fae0a1585db819

[Richard Henwood (Inactive)]

I've created this change of you diff, for review: http://review.whamcloud.com/#/c/14481/

You do not appear to have an account on http://review.hpdd.intel.com

Please let me know when you do, and I'll add you as a reviewer.

[Chris Hunter (Inactive)]

Hi Richard,
Thanks for the follow-up.

Your patch looks like my diff output plus useful comments. I created a gerrit account, do I need to sign-off on something ?

I haven't groked all the instructions to push changes into gerrit for review. Appears to be a lot of setup work in order update two lines in the lustre manual. It was simpler to attach the patch to the jira ticket.

[Chris Hunter (Inactive)]

Hi Richard,
You last diff appears to have backed out changes. Was there a problem with my change ?

chris hunter

[Chris Hunter (Inactive)]

updated diff patch,
remove extraneous semi-colon between xml tags

[Richard Henwood (Inactive)]

Yes. It is a large overhead for a single line.

I have considered the change over the weekend, and have concluded that it is better to include the redundant terms consistently, rather than drop them for >2.5.0 Lustre. My main reason here is that the manual attempts to support all version of Lustre 2.x using text decorations. If the options are included as a requirement, text decorations that identify which version of Lustre the options are related to are not necessary.

Thoughts?

[Chris Hunter (Inactive)]

Hi Richard,
If you look at the doc for mkfs.lustre command, this change was already made. My proposed change to tunefs.lustre entry attempts to be consistent with the previous doc change.

[Richard Henwood (Inactive)]

Yes. Consistency is necessary to avoid confusion.

My most recent change achieves consistency by adding in the redundant text to the place where it had been removed. The reason I chose this path is as the safest advice that covers users if they are using this manual for <2.5 Lustre.

My understanding is, if you have a pre 2.5.1 Lustre, these extra options are needed. If you have post 2.5.1, these options are redundant, and ignored. It works for both cases.

Does that make sense to you?

Doing this job correctly would add in a note to the user indicating these options are redundant post 2.5... which is maybe the equivalent of removing the options and having a clause if you are using pre-2.5 Lustre... however, we do have a 'since Lustre version X' decorator, but no 'prior to Lustre version X' decorator. For an example of a version decoration: https://build.hpdd.intel.com/job/lustre-manual/lastSuccessfulBuild/artifact/lustre_manual.xhtml#dbdoclet.lfsmkdir

[Chris Hunter (Inactive)]

updated diff patch to include "In Lustre 2.5" decorator for mkfs.lustre & tunefs.lustre documentation.
FWIW, added decorators breaks table formatting.

[Chris Hunter (Inactive)]

Updated diff patch to include "In Lustre 2.5" decorator for mkfs.lustre & tunefs.lustre documentation.

[Gerrit Updater]

Richard Henwood ([e-mail]) merged in patch http://review.whamcloud.com/14481/
Subject: LUDOC-273 tune: update tunefs.lustre
Project: doc/manual
Branch: master
Current Patch Set:
Commit: 1b48b817725e29558102bb05b1b6afb081440f98

[Richard Henwood (Inactive)]

Thanks for your patience (through seemingly small technicalities and my absence on vacation) Chris!