[LUDOC-63] liblustreapi examples have bad include statement

• Status: Closed
• Project: Lustre Documentation
• Type: Bug
• Priority: Minor
• Reporter: Christopher Morrone
• Assignee: Richard Henwood (Inactive)
• Resolution: Fixed
• Labels: QContent

Environment

Lustre 2.1.? and current manual

• Business Value: 20
• Severity: 3

Description

The manual's chapter about "Setting Lustre Properties in a C Program (llapi)" (currently chapter 34), has the following incorrect include in many of the examples:

    #include <liblustre.h>

I see that several also have:

    #include <lustre/lustre_idl.h>

I would hope that isn't necessary either, but we'd need a code review to be sure.

The user that hit this has had other problems with the manual as well. It is clearly in pretty bad shape. We really need someone to go through the manual and actually test all of the command-line examples. If we had all the time in the world, and were feeling really ambitious, we would move all of the examples into actual C files and make them part of our regression test suite. Then we would put the manual's docbook source right in the Lustre source tree, and have it include the same exact C source files that are used in the regression suite. Then when the tests need to be modified, the example in the manual would change at the same time.

For now, we just need to correct the manual, and manually test the examples.

Issue Links

• is related to: LU-1606 lustre_idl.h does not compile in user...
• is related to: LUDOC-28 improve documentation examples for li...

Comments

[Christopher Morrone]

Also, many of the C examples are not formatted in a sane way for the web version of the manual. I haven't checked the pdf version.

[Christopher Morrone]

Looks like lustre_idl.h is needed in at least some of the examples. liblustre.h still needs to be removed.

[Christopher Morrone]

Oh, and remove all of the commented-out includes as well. Thats bad to leave them in the manual.

[Richard Henwood (Inactive)]

this was fixed in LUDOC-28