[LUDOC-264] New "-o" option for setstripe missing from manpage and usage

• Status: Resolved
• Project: Lustre Documentation
• Type: Bug
• Priority: Minor
• Reporter: Gary Hagensen (Inactive)
• Assignee: Lustre Manual Triage
• Resolution: Duplicate
• Labels: easy

Environment

IEEL 2.0.1.1

• Severity: 4

Description

There is a "-o" option to the setstripe command that is not documented in the man page and also does not show up in the command usage.It is also not documented in section 18 of the Lustre Manual along with the other setstripe information. The first reference I believe is in 19.2.1.1 but there is no explanation there either.

Issue Links

• is related to: LUDOC-398 Methodology to keep manual in sync wi...

Comments

[Andreas Dilger]

The "-o" option is deprecated and intentionally omitted from the man page and usage message. It should also be removed from the manual. It is replaced by the "-i" option. Using "lfs setstripe -o" should print a message about it being deprecated in favour of "-i", and continue on.

I'll move this bug over to LUDOC to update the manual.

[Andreas Dilger]

Hmm, to clarify my previous comment - the old "-o" option is deprecated since 2.3.0, but a new "-o" option (with forward compatible semantics, don't worry) has been added to Lustre 2.7.0 via LU-4665. I don't think that the new "-o" functionality is available in the release you are running, but we should document this option clearly in any case.

In the context of the example in section 19.2.1.1, it should use "--index|-i" instead. There are also a couple of places where "lfs setstripe" is used with the deprecated positional parameters instead of named arguments that should also be fixed.

[Andreas Dilger]

The new -o option is documented in the lfs-setstripe.1 man page via patch https://review.whamcloud.com/25741 since 2.10.

IMHO, we should make some kind of automated process to import man pages from the Lustre source into the manual, or just remove them from the manual and reference some website that will do man page rendering for us. Keeping the manual up-to-date by hand is bound to be a losing battle, it is hard enough to keep the actual man pages in sync.

[Joseph Gmitter (Inactive)]

Andreas, are you envisioning a man page appendix to the manual perhaps?

[Joseph Gmitter (Inactive)]

I am going to open a new LUDOC ticket for the above.  I think this is a very worthwhile investigation.

LUDOC-398 created.

[Andreas Dilger]

Fix the manual sync in LUDOC-398.