LinearTapeFileSystem / ltfs

Reference implementation of the LTFS format Spec for stand alone tape drive

BSD 3-Clause "New" or "Revised" License

256 stars 77 forks source link

Doc: Fix incorrect use of capture index in selfDoc. #337

Closed dabiged closed 2 years ago

dabiged commented 2 years ago

Summary of changes

The self documentation describing the changes made in #330 are out of date. This PR fixes this issue.

Description

See Commit changes.

Type of change

Please delete items that are not relevant.

Updates documentation to reflect #330

Checklist:

[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my own code
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[x] I have confirmed my fix is effective or that my feature works

piste-jp commented 2 years ago

Did you try the option --capture-index on the command ltfs ? I believe The description of #330 is not correct.

Change --capture-index option in ltfs and ltfsck to have a destination directory

It shall be

Change --capture-index option in ltfsck and -o capture_index option in ltfs to have a destination directory

In the ltfs command, options to control behavior of filesystem starts from -o. -o capture_index option is one of them.

dabiged commented 2 years ago

I currently have ltfs running on multiple machine using ae184803c56f50. This week I deployed a new machine and used the latest code including the breaking change introduced by #330. I was unable to get the new version to work due to ambiguities in the documentation around #330 .

For example:

the man page for ltfs says to use --capture-index=dir.
the self help for ltfs says to use -o capture_index=<dir>.

This PR was supposed to correct this mismatch in documentation.

It seems from your feedback that it is the man page that is incorrect.

piste-jp commented 2 years ago

Sorry for your confusion.

It seems from your feedback that it is the man page that is incorrect.

You are correct. The description in ltfs.sgml is not correct and ltfs.8 is also incorrect because it is created from ltfs.sgml.

piste-jp commented 2 years ago

I rebuild ltfs.8 and push it on my bench.

The man pages are NOT generated automatically in the build process because the docbook package is required. But it is not provided into the main target OS, RHEL7.

piste-jp commented 2 years ago

@dabiged

Thank you for your fix !

dabiged commented 2 years ago

Thank you @piste-jp-ibm and the whole LTFS for supporting such a fantastic piece of software!