The Samba-Bugzilla – Bug 9531
version no fix for some manpages/*.xml
Last modified: 2017-12-07 12:38:11 UTC
Created attachment 8376 [details]
version no fix patch
Some manpages/*.xml file has wrong version in <VERSION> section.
This is fix patch.
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?
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.
We seem to have commits like this:
Author: Karolin Seeger <firstname.lastname@example.org>
AuthorDate: Thu Jan 12 09:01:54 2017 +0100
Commit: Stefan Metzmacher <email@example.com>
CommitDate: Thu Jan 12 15:35:12 2017 +0100
docs: Bump version up to 4.7.
Signed-off-by: Karolin Seeger <firstname.lastname@example.org>
Reviewed-by: Stefan Metzmacher <email@example.com>
which has changes like this:
- <refmiscinfo class="version">4.6</refmiscinfo>
+ <refmiscinfo class="version">4.7</refmiscinfo>
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>
(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.
in the man man page, the current version is shown but the static text "This man page is correct for version 4 of the Samba suite." is the only version information that is rendered on the html version of the smb.conf man page, see https://www.samba.org/samba/docs/man/manpages-3/smb.conf.5.html