Skip to content

Commit

Permalink
documentation: convert docbook to asciidoc
Browse files Browse the repository at this point in the history
Many years ago, documentation in fvwm went from raw manpages to docbook
format as a canonical source.  The idea was that this horrific XML
source could generate both manpages and HTML files.

This worked fine, however it meant that writing documentation became an
horrendous chore -- the XML markup was verbose, unsightly and got in the
way of actually documenting anything.

Although markup languages have an overhead, asciidoc seems like a good
replacement for bringing back the documentation to as close to plain
text as possible -- and can still generate the single-source files to
other output formats beyond just man pages.

This commit does a few things:

* Converts roff output to asciidoc (originally via Pandoc)
* Removes docbook support
* Hooks in asciidoc
* Updates CI/CD

The asciidoc generator of choice is `asciidoctor`.

HTML generation of documentation has been removed.  Hence, the option of
`--enable-htmldoc` via `./configure` no longer exists.

Although this commit should be several small ones, getting this to build
incrementally is difficult.
  • Loading branch information
ThomasAdam committed Nov 22, 2020
1 parent 0e5f75b commit a72eef5
Show file tree
Hide file tree
Showing 427 changed files with 15,950 additions and 85,094 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ ENV GO111MODULE="on"
COPY . /build
WORKDIR /build

RUN ./autogen.sh && ./configure --enable-golang && make -j4
RUN ./autogen.sh && ./configure --enable-mandoc --enable-golang && make -j4
2 changes: 1 addition & 1 deletion Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ SUBDIRS = \
# make distcheck2 # instead of make distcheck
# make distclean2 # instead of make distclean

DISTCHECK_CONFIGURE_FLAGS = --enable-htmldoc
DISTCHECK_CONFIGURE_FLAGS = --enable-mandoc

distcheck2: distcheck
@banner="$(distdir).tar.gz - ready for distribution"; \
Expand Down
8 changes: 2 additions & 6 deletions bin/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,7 @@ bin_SCRIPTS = fvwm-config fvwm-perllib \
fvwm-menu-xlock fvwm-menu-directory \
fvwm-menu-desktop

man_MANS = \
fvwm-root.1 fvwm-config.1 fvwm-perllib.1 \
fvwm-convert-2.6.1 \
fvwm-menu-xlock.1 fvwm-menu-directory.1 \
fvwm-menu-desktop.1
man_MANS = fvwm-menu-xlock.1

LDADD = -L$(top_builddir)/libs $(X_LIBS) -lfvwm3 $(xpm_LIBS) $(Xcursor_LIBS) \
$(X_PRE_LIBS) -lXext -lX11 -lm $(X_EXTRA_LIBS) $(Xrender_LIBS) \
Expand Down Expand Up @@ -58,7 +54,7 @@ _fvwm-perllib.1: fvwm-perllib
rm -rf $$TMP)

regenerate: \
_fvwm-menu-xlock.1 _fvwm-menu-directory.1 _fvwm-perllib.1
_fvwm-menu-xlock.1

## Create compatibility symlinks if available

Expand Down
152 changes: 0 additions & 152 deletions bin/fvwm-config.1.in

This file was deleted.

114 changes: 0 additions & 114 deletions bin/fvwm-convert-2.6.1.in

This file was deleted.

Loading

0 comments on commit a72eef5

Please sign in to comment.