Bug 9531 - version no fix for some manpages/*.xml
version no fix for some manpages/*.xml
Status: ASSIGNED
Product: Samba 4.1 and newer
Classification: Unclassified
Component: Documentation
4.7.0rc2
All All
: P5 minor
: ---
Assigned To: Karolin Seeger
Samba Documentation QA Contact~
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2013-01-02 13:55 UTC by oota toshiya
Modified: 2017-07-17 08:53 UTC (History)
1 user (show)

See Also:


Attachments
version no fix patch (33.78 KB, text/plain)
2013-01-02 13:55 UTC, oota toshiya
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description oota toshiya 2013-01-02 13:55:26 UTC
Created attachment 8376 [details]
version no fix patch

Some manpages/*.xml file has wrong version in <VERSION> section.

This is fix patch.
Comment 1 Karolin Seeger 2013-01-03 07:51:25 UTC
Thanks for providing the patch, it's much appreciated!

But in this case, I think it does not make sense to update the version information, without updating the manpages according to the 4.0 changes. They need careful review first. Please note that these version information have not been updated in the past. They were added when creating the manpage. We need to go through all manpages and can update the version afterwards.

I agree that it's confusing, but bumping the version without updating the content would be wrong IMHO.

Do you agree?
Comment 2 oota toshiya 2013-01-03 09:48:39 UTC
I approve of your opinion in general. 
However, several documents, the version does not match obviously.
For example, net.8.xml, some functions were added by the version 4. But version is still "3". 
Also,  as idmap_autorid.8.xml, version is not listed.
What is not changed from a version 3.0.35, I consider it better to change description. For example,  "added new" instead of "correct to".
When I translate it, I will not be confused.
My English is not good, so, I think there is a better representation.
Comment 3 Stefan Metzmacher 2017-07-13 04:49:09 UTC
We seem to have commits like this:

commit ecec8bb8d575d9ca5df604621033ec3d285f8ece
Author:     Karolin Seeger <kseeger@samba.org>
AuthorDate: Thu Jan 12 09:01:54 2017 +0100
Commit:     Stefan Metzmacher <metze@samba.org>
CommitDate: Thu Jan 12 15:35:12 2017 +0100

    docs: Bump version up to 4.7.
    
    Signed-off-by: Karolin Seeger <kseeger@samba.org>
    Reviewed-by: Stefan Metzmacher <metze@samba.org>

which has changes like this:

-       <refmiscinfo class="version">4.6</refmiscinfo>
+       <refmiscinfo class="version">4.7</refmiscinfo>
 </refmeta>

But this seems to be ignored by the build of manpages.

And git grep 'This man page is correct for version' still
returns things like:

docs-xml/manpages/dbwrap_tool.1.xml:    <para>This man page is correct for version 3 of the Samba suite.</para>
docs-xml/manpages/eventlogadm.8.xml:    <para>This man page is correct for version 3.0.25 of the Samba suite.</para>
Comment 4 Andrew Bartlett 2017-07-17 08:53:16 UTC
(In reply to Stefan Metzmacher from comment #3)
We really should just use an XML entity, and make the sentence say the manpage was built for VERSION.