[rsyslog] [PATCH] man-i18n patches summary

[Rainer Gerhards]

Hi,

I was now able to apply the patch series - many thanks. It is currently
in the docbook branch, which is also available on my public git server
(so that others can follow).

I am digging into what the patches actually do and, not surprisingly, I
finally need to learn a bit more about docbook to fully understand it
(looks like this gets my prime activity for the time being ;)).

One thing I already noticed. The man pages are generated via the
--enable-regenerate-man switch, but they are also in git. So when I
regenerate them, this results in a large volume of git changes.

In my POV, the man pages are now output files and as such no longer
something that belongs into git. I understand that this has the
implication that when I remove them from git, everyone who pulls the git
archive needs to have the proper tools in place to generate the doc.
However, is this really a problem? AFAIK other projects have similar
demands. So I would prefer to remove the man pages themselves from git
(but of course not from autotools config files, so that they be still
present in a release tarball).

Does this sound reasonable? Any objections (from anyone)?

I also have not yet fully understood the translation workflow. If
the ./ja subdirectory is copied, doesn't it (soon) contain the Japanese
version? If so, shouldn't any other subdirectory be copied (e.g. an ./en
be created with the English source doc, which I maintain)?

Please advise.

Thanks,
Rainer


On Thu, 2008-08-21 at 02:07 +0900, Satoru SATOH wrote:
> Hello,
> 
> 
> I posted the first patch but it seems the patch was too big to post. I
> list them here at once.
> 
> Could you please take some time to review these and merge them?
> 
> 
> I splitted origianl big patch into minimum units. However, to complete
> to man-i18n support, the following patches must be applied in this
> order.
> 
> All of the patches below are available from
> http://www.gnome.gr.jp/~ss/t/rsyslog/.
> 
> 
> 1. 0001-man-i18n-move-man-files-from-tools-to-man-C.patch
> 
> This patch just moves man files from tools/ to man/C/ (new dir to hold
> man related stuff) and update related Makefile.am files.
> 
> 
> 2. 0002-man-i18n-add-man-ja.patch
> 
> This patch creates new dir, man/ja/ and Makefile.am in it.
> 
> There are no man files in it and this should not have harmful effects
> for build process at all, I guess.
> 
> 
> 3. 0003-man-i18n-add-man-ja.patch
> 
> This patch adds man files in man/ja and update Makefile.am in it to
> install these.
> 
> 
> 4. 0004-man-i18n-add-docbook-xml-sources-for-man-files.patch
> 
> This patch adds docbook XML sources for man pages.
> 
> 
> 5. 0005-man-i18n-add-m4-macros-in-m4-and-make-aclocal-look.patch
> 
> This patch adds m4 macros in m4/ and make aclocal look for this dir.
> 
> These m4 files are not evaluated in actual and this should not have
> adverse effect at all, I guess.
> 
> 
> 6. 0006-man-i18n-add-build-process-of-man-pages-in-Makefile.patch
> 
> This patch adds transformation process of man pages and po files in
> Makefile.am.
> 
> Added part are in "if ENABLE_REGENERATE_MAN ... endif" and
> ENABLE_REGENERATE_MAN is not defined at this point, so this also should
> not have side effects.
> 
> 
> 7. 0007-man-i18n-add-enable-regenerate-man-option-for-con.patch
> 
> This is the last one. This patch adds "--enable-regenerate-man"
> configure option to enable man build process.
> 
> This option is disabled by default and should not affect normal build
> process, I think.
> 
> 
> How to build:
> 
> To enable the man build process, configure have to be regenerated:
> 
>   $ (autoreconf -vfi && \
>         ./configure --enable-regenerate-man [...other options] && \
>         make && make install
> 
> 
> Translator's workflow:
> 
>  a. initial translation:
> 
>    0. arrange lang dir, that is, cp man/ja to man/YOUR_LANG/ and edit
>       Makefile.am; s/ja/YOUR_LANG/.
>    1. create POT: make -C man/YOUR_LANG/ create-pot
>    2. copy POT to PO and translate it
>    3. run make
> 
>  b. maintanance:
> 
>    1. update PO: make -C man/YOUR_LANG update-po
>    2. update translations
>    3. just run make
> 
> 
> Requirements for man regeneration / translation:
>  
>    xmllint, xsltproc, xml2po in gnome-doc-utils, DocBook DTD and DocBook
>    xslt stylesheet for man pages are required.
> 
>    If xmlcatalog (e.g. /etc/xml/catalog) is configured appropriately,
>    both xmllint and xsltproc will use local DTD and stylsheet files
>    instead of these from remote site
>    (http://www.oasis-open.org/docbook/...).
> 
> 
> - satoru
> _______________________________________________
> rsyslog mailing list
> http://lists.adiscon.net/mailman/listinfo/rsyslog