Uploaded image for project: 'Lustre Documentation'
  1. Lustre Documentation
  2. LUDOC-28

improve documentation examples for liblustreapi functions

Details

    • Improvement
    • Resolution: Fixed
    • Minor
    • None
    • None
    • 1
    • 23
    • 7182

    Description

      Per LU-926: A user found problems by trying the llapi example in the lustre manual. There are at least two obvious bugs in that example (just try compiling it, you'll see them), so that should be fixed as well.

      Attachments

        Issue Links

          is related to

          Bug - A problem which impairs or prevents the functions of the product. LU-1606 lustre_idl.h does not compile in user-space

          • Critical - Crashes, loss of data, severe memory leak.
          • Closed
          is related to

          Bug - A problem which impairs or prevents the functions of the product. LU-926 llapi_file_fget_lov_uuid() is broken in 2.1

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. LUDOC-63 liblustreapi examples have bad include statement

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Closed

          Activity

            [LUDOC-28] improve documentation examples for liblustreapi functions
            rhenwood Richard Henwood (Inactive) added a comment -

            i've refreshed the code examples to work with the current master:

            http://review.whamcloud.com/#change,1879

            rhenwood Richard Henwood (Inactive) added a comment - i've refreshed the code examples to work with the current master: http://review.whamcloud.com/#change,1879
            rhenwood Richard Henwood (Inactive) added a comment -

            Indeed! thanks for the prompt: not only does <programlisting> look perfect for this, I've found a page on including external code examples to allow breaking out the programs to simplify testing: http://www.sagehill.net/docbookxsl/ExternalCode.html.

            Thanks for the prompt!

            rhenwood Richard Henwood (Inactive) added a comment - Indeed! thanks for the prompt: not only does <programlisting> look perfect for this, I've found a page on including external code examples to allow breaking out the programs to simplify testing: http://www.sagehill.net/docbookxsl/ExternalCode.html . Thanks for the prompt!
            morrone Christopher Morrone (Inactive) added a comment -

            It might be better to use the <programlisting> docbook element for these program examples, instead of <screen>.

            morrone Christopher Morrone (Inactive) added a comment - It might be better to use the <programlisting> docbook element for these program examples, instead of <screen>.
            morrone Christopher Morrone (Inactive) added a comment -

            Richard, did you ever put the .c files somewhere?

            morrone Christopher Morrone (Inactive) added a comment - Richard, did you ever put the .c files somewhere?
            adilger Andreas Dilger added a comment -

            Assign to Richard, since he is mostly working on this.

            adilger Andreas Dilger added a comment - Assign to Richard, since he is mostly working on this.
            rhenwood Richard Henwood (Inactive) added a comment -

            For a first draft at a regression test against Chris's LU-1606 fixes I have created a directory:

            lustre/tests/clientapi/

            I propose to put the examples from the manual in there.

            rhenwood Richard Henwood (Inactive) added a comment - For a first draft at a regression test against Chris's LU-1606 fixes I have created a directory: lustre/tests/clientapi/ I propose to put the examples from the manual in there.
            adilger Andreas Dilger added a comment -

            I agree - having a subdirectory in the Lustre Git repo with all of the examples as .c files that are built every time would be the best way to ensure they continue to compile over time. Copying them into the manual occasionally is better than if they never get updated, and we can work on automating this process later, once we have examples that actually build and run.

            adilger Andreas Dilger added a comment - I agree - having a subdirectory in the Lustre Git repo with all of the examples as .c files that are built every time would be the best way to ensure they continue to compile over time. Copying them into the manual occasionally is better than if they never get updated, and we can work on automating this process later, once we have examples that actually build and run.

            People

              rhenwood Richard Henwood (Inactive)
              adilger Andreas Dilger
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: