[PATCH xserver 00/15] man pages: generating using XORG_MAN_SECTIONS

Gaetan Nadon memsize at videotron.ca
Sun Jan 9 17:27:44 PST 2011


	*** Ready for git master

Man pages are created using various tools to do string substitutions,
various file types for source and various methods for generated files
like copying and/or linking.

The first 13 patches change the way the man pages are generated
to use the same method as in the rest of xorg.
The strings for substitutions are now all located in a single file.

1) The source is stored in a file with .man extension in git
2) The string substitutions are done by $SED
3) No intermediate generated files copied or linked
4) The man pages are generated from a dedicated makefile

The following directories contain the affected man pages
doc/man
hw/xwin/man
hw/xfree86/utils/man
hw/xfree86/doc/man
hw/xfree86/fbdevhw/man
hw/xfree86/exa/man
hw/kdrive/ephyr/man
hw/vfb/man
hw/xquartz/doc
hw/dmx/man
hw/dmx/config/man
hw/xnest/man

Gaetan Nadon (15):
  Xorg.man: fix whitespace issues
  man: build Xorg and xorg.conf man pages using XORG_MANPAGE_SECTIONS
  Xquartz: build Xquartz man pages using XORG_MANPAGE_SECTIONS
  Xquartz: strip the man page code from cpprules.in
  Xnest: build Xnest man pages using XORG_MANPAGE_SECTIONS
  XWin: build XWin man pages using XORG_MANPAGE_SECTIONS
  Xvfb: build Xvfb man pages using XORG_MANPAGE_SECTIONS
  Xephyr: build Xephyr man pages using XORG_MANPAGE_SECTIONS
  XFree86 utils: build utils man pages using XORG_MANPAGE_SECTIONS
  fbdevhw: build man pages using XORG_MANPAGE_SECTIONS
  exa: build man pages using XORG_MANPAGE_SECTIONS
  Xdmx: build all man pages using XORG_MANPAGE_SECTIONS
  man: refactor common code in the man pages makefiles
  xfree86: use sed rather than cpp to perform string substitutions
  Xquartz: rename man page directory from doc to man

 configure.ac                                       |   11 +-
 cpprules.in                                        |   49 --
 doc/man/Makefile.am                                |   16 +-
 hw/dmx/Makefile.am                                 |   25 +-
 hw/dmx/config/Makefile.am                          |   21 +-
 hw/dmx/config/man/Makefile.am                      |    2 +
 hw/dmx/config/{ => man}/dmxtodmx.man               |    0
 hw/dmx/config/{ => man}/vdltodmx.man               |    0
 hw/dmx/config/{ => man}/xdmxconfig.man             |    0
 hw/dmx/man/Makefile.am                             |    2 +
 hw/dmx/{ => man}/Xdmx.man                          |    0
 hw/kdrive/ephyr/.gitignore                         |    2 -
 hw/kdrive/ephyr/Makefile.am                        |   18 +-
 hw/kdrive/ephyr/man/Makefile.am                    |    2 +
 hw/kdrive/ephyr/{Xephyr.man.pre => man/Xephyr.man} |    8 +-
 hw/vfb/.gitignore                                  |    2 -
 hw/vfb/Makefile.am                                 |   21 +-
 hw/vfb/man/Makefile.am                             |    2 +
 hw/vfb/{Xvfb.man.pre => man/Xvfb.man}              |   12 +-
 hw/xfree86/.gitignore                              |    3 -
 hw/xfree86/Makefile.am                             |   18 +-
 hw/xfree86/doc/man/.gitignore                      |    4 -
 hw/xfree86/doc/man/Makefile.am                     |   27 +-
 hw/xfree86/doc/man/{Xorg.man.pre => Xorg.man}      |   14 +-
 .../doc/man/{xorg.conf.man.pre => xorg.conf.man}   |    0
 hw/xfree86/exa/.gitignore                          |    2 -
 hw/xfree86/exa/Makefile.am                         |   14 +-
 hw/xfree86/exa/man/Makefile.am                     |    2 +
 hw/xfree86/exa/{exa.man.pre => man/exa.man}        |    4 +-
 hw/xfree86/fbdevhw/.gitignore                      |    2 -
 hw/xfree86/fbdevhw/Makefile.am                     |   14 +-
 hw/xfree86/fbdevhw/man/Makefile.am                 |    2 +
 .../fbdevhw/{fbdevhw.man.pre => man/fbdevhw.man}   |    4 +-
 hw/xfree86/utils/Makefile.am                       |    3 +-
 hw/xfree86/utils/cvt/.gitignore                    |    2 -
 hw/xfree86/utils/cvt/Makefile.am                   |    8 -
 hw/xfree86/utils/gtf/.gitignore                    |    2 -
 hw/xfree86/utils/gtf/Makefile.am                   |   17 -
 hw/xfree86/utils/man/Makefile.am                   |    2 +
 hw/xfree86/utils/{cvt/cvt.man.pre => man/cvt.man}  |    2 +-
 hw/xfree86/utils/{gtf/gtf.man.pre => man/gtf.man}  |    0
 hw/xfree86/xorgconf.cpp                            |  610 ++++++++++----------
 hw/xnest/.gitignore                                |    2 -
 hw/xnest/Makefile.am                               |   26 +-
 hw/xnest/man/Makefile.am                           |    2 +
 hw/xnest/{Xnest.man.pre => man/Xnest.man}          |    0
 hw/xquartz/Makefile.am                             |    4 +-
 hw/xquartz/bundle/cpprules.in                      |   22 +-
 hw/xquartz/doc/Makefile.am                         |   16 -
 hw/xquartz/man/Makefile.am                         |    2 +
 .../{doc/Xquartz.man.pre => man/Xquartz.man}       |    0
 hw/xwin/.gitignore                                 |    3 -
 hw/xwin/Makefile.am                                |   27 +-
 hw/xwin/man/Makefile.am                            |    3 +
 hw/xwin/{XWin.man.pre => man/XWin.man}             |    0
 hw/xwin/{XWinrc.man.pre => man/XWinrc.man}         |    0
 manpages.am                                        |   37 ++
 57 files changed, 432 insertions(+), 661 deletions(-)
 delete mode 100644 cpprules.in
 create mode 100644 hw/dmx/config/man/Makefile.am
 rename hw/dmx/config/{ => man}/dmxtodmx.man (100%)
 rename hw/dmx/config/{ => man}/vdltodmx.man (100%)
 rename hw/dmx/config/{ => man}/xdmxconfig.man (100%)
 create mode 100644 hw/dmx/man/Makefile.am
 rename hw/dmx/{ => man}/Xdmx.man (100%)
 create mode 100644 hw/kdrive/ephyr/man/Makefile.am
 rename hw/kdrive/ephyr/{Xephyr.man.pre => man/Xephyr.man} (98%)
 create mode 100644 hw/vfb/man/Makefile.am
 rename hw/vfb/{Xvfb.man.pre => man/Xvfb.man} (99%)
 delete mode 100644 hw/xfree86/doc/man/.gitignore
 rename hw/xfree86/doc/man/{Xorg.man.pre => Xorg.man} (99%)
 rename hw/xfree86/doc/man/{xorg.conf.man.pre => xorg.conf.man} (100%)
 delete mode 100644 hw/xfree86/exa/.gitignore
 create mode 100644 hw/xfree86/exa/man/Makefile.am
 rename hw/xfree86/exa/{exa.man.pre => man/exa.man} (96%)
 delete mode 100644 hw/xfree86/fbdevhw/.gitignore
 create mode 100644 hw/xfree86/fbdevhw/man/Makefile.am
 rename hw/xfree86/fbdevhw/{fbdevhw.man.pre => man/fbdevhw.man} (95%)
 create mode 100644 hw/xfree86/utils/man/Makefile.am
 rename hw/xfree86/utils/{cvt/cvt.man.pre => man/cvt.man} (99%)
 rename hw/xfree86/utils/{gtf/gtf.man.pre => man/gtf.man} (100%)
 create mode 100644 hw/xnest/man/Makefile.am
 rename hw/xnest/{Xnest.man.pre => man/Xnest.man} (100%)
 delete mode 100644 hw/xquartz/doc/Makefile.am
 create mode 100644 hw/xquartz/man/Makefile.am
 rename hw/xquartz/{doc/Xquartz.man.pre => man/Xquartz.man} (100%)
 create mode 100644 hw/xwin/man/Makefile.am
 rename hw/xwin/{XWin.man.pre => man/XWin.man} (100%)
 rename hw/xwin/{XWinrc.man.pre => man/XWinrc.man} (100%)
 create mode 100644 manpages.am



More information about the xorg-devel mailing list