Details
-
Bug
-
Resolution: Fixed
-
Minor
-
None
-
None
-
Lustre 2.1.? and current manual
-
20
-
3
-
7151
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.
Attachments
Issue Links
Activity
| Status | Original: Resolved [ 5 ] | New: Closed [ 6 ] |
| Resolution | New: Fixed [ 1 ] | |
| Status | Original: Open [ 1 ] | New: Resolved [ 5 ] |
| Business Value | New: 20 |
| Labels | New: QContent |
| Description |
Original:
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: {noformat} #include <liblustre.h> {noformat} I see that several also have: {nofromat} #include <lustre/lustre_idl.h> {noformat} 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. |
New:
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: {noformat} #include <liblustre.h> {noformat} I see that several also have: {noformat} #include <lustre/lustre_idl.h> {noformat} 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. |
| Assignee | Original: Jessica A. Popp [ jessica ] | New: Richard Henwood [ rhenwood ] |