2025-07-22 02:07 CEST

View Issue Details Jump to Notes ]
IDProjectCategoryView StatusLast Update
0001707Spring engineLinuxpublic2009-11-20 13:52
Reportermammadori 
Assigned Tohoijui 
PrioritynormalSeverityminorReproducibilityN/A
StatusresolvedResolutionfixed 
Product Version0.80.5 
Target Version0.81.0.0Fixed in Version0.80.5+git 
Summary0001707: [patch] spring and spring-dedicated manpages
DescriptionThose are the minimal manpages for spring and spring-dedicated we are using in debian packaging, feel free to include in your tarballs.

I release there as GPL2 as spring license althought in debian packaging are available with GPL3 to ease your adoption.
TagsNo tags attached.
Checked infolog.txt for Errors
Attached Files

-Relationships
+Relationships

-Notes

~0004272

mammadori (reporter)

Last edited: 2009-10-27 11:18

Updated manpages after being reviewed by debian-l10n-english people.

Trash the former archive (which is named incorrectly as .tar.gz being just an uncompressed tar) and use please the _rev named.

~0004292

tvo (reporter)

Where should they be installed, if they go in our tarball?

Or would it already be useful if I just stick them into the Documentation/ folder and not install them on `make install' ?

~0004293

mammadori (reporter)

In my debian packaging I build them and the packaging system will let them end gzipped in /usr/share/man/man6/ as in :

$ dpkg -L spring | grep man | grep gz
/usr/share/man/man6/spring-dedicated.6.gz
/usr/share/man/man6/spring.6.gz

I use asciidoc to build manpages, but since those two are really simple, you could stick to the resulting troff format, as if you do not want to add more build dependencies; just build them with the supplied Makefile and put the results in "Documentation" and add the rule to Cmake to have them just gzipped and installed in /usr/share/man/man6.

~0004334

hoijui (reporter)

i have it all setup with CMake now, the only problem i have is a bug with asciidoc in ubuntu jaunty (see below), but other then that, it seems to work fine.
https://bugs.launchpad.net/ubuntu/+source/asciidoc/+bug/368119

Someone pleast test it.
done in commit: 6819e1c7433f02cb52a6055238a7f5f80635dbf3
commit message:
add MAN pages to CMake build on unix (apply mantis 0001707 by mammadori)
    For this to work, you need to have asciidoc installed.
    New CMake var: MANDIR (default: share/man)
    This means, by default, man pages will be installed /usr/share/man/man6/.
    You may set it to the same value like BINDIR and LIBDIR, eg ".",
    in case you don not want to install system wide, but to a dedicated dir.
    CMake also checks for the asciidoc utility to work properly,
    as there it is borked in Ubuntu jaunty (and probably other distros).
    
    Adding, removing or altering man pages only required fiddling around
    with the ".6.txt" files. Compilation will only break if there is none
    of these left.

~0004344

mammadori (reporter)

Tested on my debian/unstable box.

It works.

As dependecies, for manpages I'm using those package in debian (look at debian/control in my package for full list):

asciidoc,
docbook-xsl,
xsltproc

~0004348

hoijui (reporter)

ok, thanks! :-)

i don't know why you tell me about these dependencies. you mean i have to check if docbook-xsl and xsltproc are available in CMake too?

~0004356

mammadori (reporter)

Sorry hoijui, I mis-tried your latest git, leaving my makefile in the build process.

So I was wrong. Your cmake + shell thing does not work.

I saw your "make_manpages.sh" and it just builds the docbook file, not the final troff manpage. It missed the xsltproc call.

Try to look at my debian/manpages/Makefile for a simple howto

http://git.debian.org/?p=pkg-games/spring.git;a=tree;f=debian/manpages;h=37f881074ee4357807074e93178d4220c0907d32;hb=HEAD

It is just a matter of an asciidoc call, followed by an xsltproc call.

~0004357

hoijui (reporter)

did an other commit, whcih should fix it, but it needs testing.. please :D

~0004358

mammadori (reporter)

Near 99%, this patch covers it:

diff --git a/Documentation/manpages/make_manpages.sh b/Documentation/manpages/make_manpages.sh
index 080c8bc..d753792 100755
--- a/Documentation/manpages/make_manpages.sh
+++ b/Documentation/manpages/make_manpages.sh
@@ -85,7 +85,7 @@ do
        # compile
        ${EXEC_ASCIIDOC} --doctype=manpage --backend=docbook --out-file="${manFile_xml}" - < "${manFile_src}" > /dev/null
        # format
- ${EXEC_XSLTPROC} --output "${manFile_xml}" "${XSL_DOCBOOK}" "${manFile_man}" > /dev/null
+ ${EXEC_XSLTPROC} --output "${manFile_man}" "${XSL_DOCBOOK}" "${manFile_xml}" > /dev/null
        # archive
        ${EXEC_7Z} a -tgzip "${manFile_cmp}" "${manFile_man}" > /dev/null
 done

~0004359

hoijui (reporter)

thank you mammadori! :-)
finally fully applied in commit: 40a864be29be4d18a2b80dac976f7e2aec1a2cfb
+Notes

-Issue History
Date Modified Username Field Change
2009-10-26 01:46 mammadori New Issue
2009-10-26 01:46 mammadori File Added: spring-manpages.tar.gz
2009-10-27 10:14 hoijui Target Version => 0.81.0.0
2009-10-27 11:15 mammadori Note Added: 0004272
2009-10-27 11:15 mammadori File Added: spring_manpages_rev.tar.gz
2009-10-27 11:18 mammadori Note Edited: 0004272
2009-11-09 15:39 tvo Note Added: 0004292
2009-11-09 19:25 mammadori Note Added: 0004293
2009-11-16 10:06 hoijui File Deleted: spring-manpages.tar.gz
2009-11-16 12:48 hoijui Note Added: 0004334
2009-11-16 12:48 hoijui Status new => feedback
2009-11-16 15:16 mammadori Note Added: 0004344
2009-11-16 17:42 hoijui Note Added: 0004348
2009-11-19 15:53 mammadori Note Added: 0004356
2009-11-19 22:31 hoijui Note Added: 0004357
2009-11-19 23:44 mammadori Note Added: 0004358
2009-11-20 13:52 hoijui Note Added: 0004359
2009-11-20 13:52 hoijui Status feedback => resolved
2009-11-20 13:52 hoijui Fixed in Version => 0.80.5+git
2009-11-20 13:52 hoijui Resolution open => fixed
2009-11-20 13:52 hoijui Assigned To => hoijui
+Issue History