<!-- 
RSS generated by JIRA (9.4.14#940014-sha1:734e6822bbf0d45eff9af51f82432957f73aa32c) at Sat Feb 10 03:39:57 UTC 2024

It is possible to restrict the fields that are returned in this document by specifying the 'field' parameter in your request.
For example, to request only the issue key and summary append 'field=key&field=summary' to the URL of your request.
-->
<rss version="0.92" >
<channel>
    <title>Whamcloud Community JIRA</title>
    <link>https://jira.whamcloud.com</link>
    <description>This file is an XML representation of an issue</description>
    <language>en-us</language>    <build-info>
        <version>9.4.14</version>
        <build-number>940014</build-number>
        <build-date>05-12-2023</build-date>
    </build-info>


<item>
            <title>[LUDOC-63] liblustreapi examples have bad include statement</title>
                <link>https://jira.whamcloud.com/browse/LUDOC-63</link>
                <project id="10070" key="LUDOC">Lustre Documentation</project>
                    <description>&lt;p&gt;The manual&apos;s chapter about &quot;Setting Lustre Properties in a C Program (llapi)&quot; (currently chapter 34), has the following incorrect include in many of the examples:&lt;/p&gt;

&lt;div class=&quot;preformatted panel&quot; style=&quot;border-width: 1px;&quot;&gt;&lt;div class=&quot;preformattedContent panelContent&quot;&gt;
&lt;pre&gt;    #include &amp;lt;liblustre.h&amp;gt;
&lt;/pre&gt;
&lt;/div&gt;&lt;/div&gt;

&lt;p&gt;I see that several also have:&lt;/p&gt;

&lt;div class=&quot;preformatted panel&quot; style=&quot;border-width: 1px;&quot;&gt;&lt;div class=&quot;preformattedContent panelContent&quot;&gt;
&lt;pre&gt;    #include &amp;lt;lustre/lustre_idl.h&amp;gt;
&lt;/pre&gt;
&lt;/div&gt;&lt;/div&gt;

&lt;p&gt;I would hope that isn&apos;t necessary either, but we&apos;d need a code review to be sure.&lt;/p&gt;

&lt;p&gt;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&apos;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.&lt;/p&gt;

&lt;p&gt;For now, we just need to correct the manual, and manually test the examples.&lt;/p&gt;</description>
                <environment>Lustre 2.1.? and current manual</environment>
        <key id="15149">LUDOC-63</key>
            <summary>liblustreapi examples have bad include statement</summary>
                <type id="1" iconUrl="https://jira.whamcloud.com/secure/viewavatar?size=xsmall&amp;avatarId=11303&amp;avatarType=issuetype">Bug</type>
                                            <priority id="4" iconUrl="https://jira.whamcloud.com/images/icons/priorities/minor.svg">Minor</priority>
                        <status id="6" iconUrl="https://jira.whamcloud.com/images/icons/statuses/closed.png" description="The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.">Closed</status>
                    <statusCategory id="3" key="done" colorName="success"/>
                                    <resolution id="1">Fixed</resolution>
                                        <assignee username="rhenwood">Richard Henwood</assignee>
                                    <reporter username="morrone">Christopher Morrone</reporter>
                        <labels>
                            <label>QContent</label>
                    </labels>
                <created>Thu, 5 Jul 2012 19:33:43 +0000</created>
                <updated>Fri, 10 May 2013 20:11:10 +0000</updated>
                            <resolved>Fri, 10 May 2013 20:11:04 +0000</resolved>
                                                                        <due></due>
                            <votes>0</votes>
                                    <watches>2</watches>
                                                                            <comments>
                            <comment id="41542" author="morrone" created="Thu, 5 Jul 2012 19:35:34 +0000"  >&lt;p&gt;Also, many of the C examples are not formatted in a sane way for the web version of the manual.  I haven&apos;t checked the pdf version.&lt;/p&gt;</comment>
                            <comment id="41545" author="morrone" created="Thu, 5 Jul 2012 20:20:46 +0000"  >&lt;p&gt;Looks like lustre_idl.h is needed in at least some of the examples.  liblustre.h still needs to be removed.&lt;/p&gt;</comment>
                            <comment id="41546" author="morrone" created="Thu, 5 Jul 2012 20:21:08 +0000"  >&lt;p&gt;Oh, and remove all of the commented-out includes as well.  Thats bad to leave them in the manual.&lt;/p&gt;</comment>
                            <comment id="58199" author="rhenwood" created="Fri, 10 May 2013 20:11:04 +0000"  >&lt;p&gt;this was fixed in &lt;a href=&quot;https://jira.whamcloud.com/browse/LUDOC-28&quot; title=&quot;improve documentation examples for liblustreapi functions&quot; class=&quot;issue-link&quot; data-issue-key=&quot;LUDOC-28&quot;&gt;&lt;del&gt;LUDOC-28&lt;/del&gt;&lt;/a&gt;&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10011">
                    <name>Related</name>
                                            <outwardlinks description="is related to ">
                                        <issuelink>
            <issuekey id="15151">LU-1606</issuekey>
        </issuelink>
                            </outwardlinks>
                                                                <inwardlinks description="is related to">
                                        <issuelink>
            <issuekey id="12680">LUDOC-28</issuekey>
        </issuelink>
                            </inwardlinks>
                                    </issuelinktype>
                    </issuelinks>
                <attachments>
                    </attachments>
                <subtasks>
                    </subtasks>
                <customfields>
                                                                                                                                    <customfield id="customfield_10003" key="com.atlassian.jira.plugin.system.customfieldtypes:float">
                        <customfieldname>Business Value</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>20.0</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10890" key="com.atlassian.jira.plugins.jira-development-integration-plugin:devsummary">
                        <customfieldname>Development</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_10390" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>1|hzvkxb:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10090" key="com.pyxis.greenhopper.jira:gh-global-rank">
                        <customfieldname>Rank (Obsolete)</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>7151</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                            <customfield id="customfield_10060" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
                        <customfieldname>Severity</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue key="10022"><![CDATA[3]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                        </customfields>
    </item>
</channel>
</rss>