#322 Issue closed: Makefile: please remove asciidoc

Labels: documentation, discuss / RFC

roseswe opened issue at 2013-10-30 07:48:

asciidoc had too many dependencies on OpenSUSE and Debian. Please consider to avoid the asciidoc usage.

make[1]: Entering directory `/home/ralph/Dokumente/scripte_git/rear/doc'
asciidoc -b docbook -d manpage rear.8.txt
make[1]: asciidoc: Command not found
make[1]: *** [rear.8.xml] Error 127

OpenSUSE 12.3

~# zypper in asciidoc
::
969 new packages to install.
Overall download size: 293.4 MiB. After the operation, additional 570.2 MiB will be used.
Continue? [y/n/?] (y): n

Debian 7.2

~# aptitude install asciidoc
::
Need to get 682 MB/705 MB of archives. After unpacking 1157 MB will be used.
Do you want to continue? [Y/n/?] n

schlomo commented at 2013-10-30 08:43:

I very much hope that asciidoc is only a build-time requirement and not a
runtime requirement. If it is a run-time requirement then we must remove it.

I see 2 possible answers:

  1. Most users use prebuilt packages and we don't care how bloated the build
    automation gets. Those few who want to build themselves probably can afford
    to either setup a build system (or use mock or build or pbuilder) or
    shouldn't mind to install an extra GB of build environment.
  2. Please suggest a better / leaner alternative. The goal is to have a
    simple human-friendly format in which we can maintain the docs. Coding
    manpages in roff is not an option.

On 30 October 2013 08:48, Ralph Roth notifications@github.com wrote:

asciidoc had too many dependencies on OpenSUSE and Debian. Please consider
to avoid the asciidoc usage.

make[1]: Entering directory `/home/ralph/Dokumente/scripte_git/rear/doc'
asciidoc -b docbook -d manpage rear.8.txt
make[1]: asciidoc: Command not found

make[1]: *** [rear.8.xml] Error 127

OpenSUSE 12.3

~# zypper in asciidoc
::
969 new packages to install.
Overall download size: 293.4 MiB. After the operation, additional 570.2
MiB will be used.

Continue? y/n/? http://y: n

Debian 7.2

~# aptitude install asciidoc
::
Need to get 682 MB/705 MB of archives. After unpacking 1157 MB will be
used.
Do you want to continue? [Y/n/?] n

—
Reply to this email directly or view it on GitHubhttps://github.com/rear/rear/issues/322
.

gdha commented at 2013-10-30 14:03:

asciidoc is a build-time requirement for the docs only. We can however, prepare the man and user-guide on-front to avoid asciidoc to be installed with developers.
Only the rear maintainer(s) is/are writing documentation unfortunately ;-/

roseswe commented at 2013-10-30 14:31:

Am 30.10.2013 15:03, schrieb gdha:

asciidoc is a build-time requirement for the docs only. We can
however, prepare the man and user-guide on-front to avoid asciidoc to
be installed with developers.
that would be great!

BTW, the same applies for (future) plans on cfg2html using asciidoc :-)

BR
Ralph

gdha commented at 2013-12-03 12:08:

we will not change theasciidoc requirement - maintainers require it for sure (pity it pulls a lot of extra code).

[Export of Github issue for rear/rear.]