Skip to content

Commit

Permalink
man: refactor common code in the man pages makefiles
Browse files Browse the repository at this point in the history
Create a manpages.am makefile snippet in the root dir.
Each man page makefile includes manpages.am.

Now all man pages in xserver are generated the same way
using the same method as all of other xorg modules.
All ".man.pre" files in git are ".man" now.
Links are no longer created between different file types.

Reviewed-by: Alan Coopersmith <[email protected]>
Reviewed-by: Rémi Cardona <[email protected]>
Signed-off-by: Gaetan Nadon <[email protected]>
Signed-off-by: Keith Packard <[email protected]>
  • Loading branch information
memsize authored and keith-packard committed Jan 18, 2011
1 parent c86f7c2 commit 885a333
Show file tree
Hide file tree
Showing 13 changed files with 49 additions and 143 deletions.
16 changes: 1 addition & 15 deletions doc/man/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,5 @@
# (i.e. those handled in the os/utils.c options processing instead of in
# the DDX-level options processing)

appmandir = $(APP_MAN_DIR)
include $(top_srcdir)/manpages.am
appman_PRE = Xserver.man
appman_DATA = $(appman_PRE:man=$(APP_MAN_SUFFIX))

EXTRA_DIST = $(appman_PRE)
CLEANFILES = $(appman_DATA)
SUFFIXES = .$(APP_MAN_SUFFIX) .man

# String replacements in MAN_SUBSTS now come from xorg-macros.m4 via configure
# 's|/,|/, |g' will add a space to help font path formatting
MAN_SUBSTS += -e 's|__datadir__|$(datadir)|g' \
-e 's|__default_font_path__|$(COMPILEDDEFAULTFONTPATH)|g' \
-e '\|$(COMPILEDDEFAULTFONTPATH)| s|/,|/, |g'

.man.$(APP_MAN_SUFFIX):
$(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
10 changes: 1 addition & 9 deletions hw/dmx/config/man/Makefile.am
Original file line number Diff line number Diff line change
@@ -1,10 +1,2 @@
appmandir = $(APP_MAN_DIR)
include $(top_srcdir)/manpages.am
appman_PRE = xdmxconfig.man vdltodmx.man dmxtodmx.man
appman_DATA = $(appman_PRE:man=$(APP_MAN_SUFFIX))

EXTRA_DIST = $(appman_PRE)
CLEANFILES = $(appman_DATA)
SUFFIXES = .$(APP_MAN_SUFFIX) .man

.man.$(APP_MAN_SUFFIX):
$(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
10 changes: 1 addition & 9 deletions hw/dmx/man/Makefile.am
Original file line number Diff line number Diff line change
@@ -1,10 +1,2 @@
appmandir = $(APP_MAN_DIR)
include $(top_srcdir)/manpages.am
appman_PRE = Xdmx.man
appman_DATA = $(appman_PRE:man=$(APP_MAN_SUFFIX))

EXTRA_DIST = $(appman_PRE)
CLEANFILES = $(appman_DATA)
SUFFIXES = .$(APP_MAN_SUFFIX) .man

.man.$(APP_MAN_SUFFIX):
$(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
10 changes: 1 addition & 9 deletions hw/kdrive/ephyr/man/Makefile.am
Original file line number Diff line number Diff line change
@@ -1,10 +1,2 @@
appmandir = $(APP_MAN_DIR)
include $(top_srcdir)/manpages.am
appman_PRE = Xephyr.man
appman_DATA = $(appman_PRE:man=$(APP_MAN_SUFFIX))

EXTRA_DIST = $(appman_PRE)
CLEANFILES = $(appman_DATA)
SUFFIXES = .$(APP_MAN_SUFFIX) .man

.man.$(APP_MAN_SUFFIX):
$(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
10 changes: 1 addition & 9 deletions hw/vfb/man/Makefile.am
Original file line number Diff line number Diff line change
@@ -1,10 +1,2 @@
appmandir = $(APP_MAN_DIR)
include $(top_srcdir)/manpages.am
appman_PRE = Xvfb.man
appman_DATA = $(appman_PRE:man=$(APP_MAN_SUFFIX))

EXTRA_DIST = $(appman_PRE)
CLEANFILES = $(appman_DATA)
SUFFIXES = .$(APP_MAN_SUFFIX) .man

.man.$(APP_MAN_SUFFIX):
$(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
24 changes: 1 addition & 23 deletions hw/xfree86/doc/man/Makefile.am
Original file line number Diff line number Diff line change
@@ -1,25 +1,3 @@
appmandir = $(APP_MAN_DIR)
include $(top_srcdir)/manpages.am
appman_PRE = Xorg.man
appman_DATA = $(appman_PRE:man=$(APP_MAN_SUFFIX))

filemandir = $(FILE_MAN_DIR)
fileman_PRE = xorg.conf.man
fileman_DATA = $(fileman_PRE:man=$(FILE_MAN_SUFFIX))

EXTRA_DIST = $(appman_PRE) $(fileman_PRE)
CLEANFILES = $(appman_DATA) $(fileman_DATA)
SUFFIXES = .$(APP_MAN_SUFFIX) .$(FILE_MAN_SUFFIX) .man

# String replacements in MAN_SUBSTS now come from xorg-macros.m4 via configure
MAN_SUBSTS += -e 's|__logdir__|$(logdir)|g' \
-e 's|__datadir__|$(datadir)|g' \
-e 's|__mandir__|$(mandir)|g' \
-e 's|__sysconfdir__|$(sysconfdir)|g' \
-e 's|__xconfigdir__|$(__XCONFIGDIR__)|g' \
-e 's|__xkbdir__|$(XKB_BASE_DIRECTORY)|g' \
-e 's|__modulepath__|$(DEFAULT_MODULE_PATH)|g'

.man.$(APP_MAN_SUFFIX):
$(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
.man.$(FILE_MAN_SUFFIX):
$(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
11 changes: 1 addition & 10 deletions hw/xfree86/exa/man/Makefile.am
Original file line number Diff line number Diff line change
@@ -1,11 +1,2 @@
drivermandir = $(DRIVER_MAN_DIR)
include $(top_srcdir)/manpages.am
driverman_PRE = exa.man
driverman_DATA = $(driverman_PRE:man=$(DRIVER_MAN_SUFFIX))

EXTRA_DIST = $(driverman_PRE)
CLEANFILES = $(driverman_DATA)
SUFFIXES = .$(DRIVER_MAN_SUFFIX) .man

# String replacements in MAN_SUBSTS now come from xorg-macros.m4 via configure
.man.$(DRIVER_MAN_SUFFIX):
$(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
11 changes: 1 addition & 10 deletions hw/xfree86/fbdevhw/man/Makefile.am
Original file line number Diff line number Diff line change
@@ -1,11 +1,2 @@
drivermandir = $(DRIVER_MAN_DIR)
include $(top_srcdir)/manpages.am
driverman_PRE = fbdevhw.man
driverman_DATA = $(driverman_PRE:man=$(DRIVER_MAN_SUFFIX))

EXTRA_DIST = $(driverman_PRE)
CLEANFILES = $(driverman_DATA)
SUFFIXES = .$(DRIVER_MAN_SUFFIX) .man

# String replacements in MAN_SUBSTS now come from xorg-macros.m4 via configure
.man.$(DRIVER_MAN_SUFFIX):
$(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
10 changes: 1 addition & 9 deletions hw/xfree86/utils/man/Makefile.am
Original file line number Diff line number Diff line change
@@ -1,10 +1,2 @@
appmandir = $(APP_MAN_DIR)
include $(top_srcdir)/manpages.am
appman_PRE = cvt.man gtf.man
appman_DATA = $(appman_PRE:man=$(APP_MAN_SUFFIX))

EXTRA_DIST = $(appman_PRE)
CLEANFILES = $(appman_DATA)
SUFFIXES = .$(APP_MAN_SUFFIX) .man

.man.$(APP_MAN_SUFFIX):
$(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
10 changes: 1 addition & 9 deletions hw/xnest/man/Makefile.am
Original file line number Diff line number Diff line change
@@ -1,10 +1,2 @@
appmandir = $(APP_MAN_DIR)
include $(top_srcdir)/manpages.am
appman_PRE = Xnest.man
appman_DATA = $(appman_PRE:man=$(APP_MAN_SUFFIX))

EXTRA_DIST = $(appman_PRE)
CLEANFILES = $(appman_DATA)
SUFFIXES = .$(APP_MAN_SUFFIX) .man

.man.$(APP_MAN_SUFFIX):
$(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
13 changes: 1 addition & 12 deletions hw/xquartz/doc/Makefile.am
Original file line number Diff line number Diff line change
@@ -1,13 +1,2 @@
appmandir = $(APP_MAN_DIR)
include $(top_srcdir)/manpages.am
appman_PRE = Xquartz.man
appman_DATA = $(appman_PRE:man=$(APP_MAN_SUFFIX))

EXTRA_DIST = $(appman_PRE)
CLEANFILES = $(appman_DATA)
SUFFIXES = .$(APP_MAN_SUFFIX) .man

# String replacements in MAN_SUBSTS now come from xorg-macros.m4 via configure
MAN_SUBSTS += -e 's|__laucnd_id_prefix__|$(LAUNCHD_ID_PREFIX)|g'

.man.$(APP_MAN_SUFFIX):
$(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
20 changes: 1 addition & 19 deletions hw/xwin/man/Makefile.am
Original file line number Diff line number Diff line change
@@ -1,21 +1,3 @@
appmandir = $(APP_MAN_DIR)
include $(top_srcdir)/manpages.am
appman_PRE = XWin.man
appman_DATA = $(appman_PRE:man=$(APP_MAN_SUFFIX))

filemandir = $(FILE_MAN_DIR)
fileman_PRE = XWinrc.man
fileman_DATA = $(fileman_PRE:man=$(FILE_MAN_SUFFIX))

EXTRA_DIST = $(appman_PRE) $(fileman_PRE)
CLEANFILES = $(appman_DATA) $(fileman_DATA)
SUFFIXES = .$(APP_MAN_SUFFIX) .$(FILE_MAN_SUFFIX) .man

# String replacements in MAN_SUBSTS now come from xorg-macros.m4 via configure
MAN_SUBSTS += -e 's|__logdir__|$(logdir)|g' \
-e 's|__datadir__|$(datadir)|g' \
-e 's|__sysconfdir__|$(sysconfdir)|g'

.man.$(APP_MAN_SUFFIX):
$(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
.man.$(FILE_MAN_SUFFIX):
$(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
37 changes: 37 additions & 0 deletions manpages.am
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
appmandir = $(APP_MAN_DIR)
#appman_PRE = list of application man page files set by calling Makefile.am
appman_DATA = $(appman_PRE:man=$(APP_MAN_SUFFIX))

drivermandir = $(DRIVER_MAN_DIR)
#driverman_PRE = list of driver man page files set by calling Makefile.am
driverman_DATA = $(driverman_PRE:man=$(DRIVER_MAN_SUFFIX))

filemandir = $(FILE_MAN_DIR)
#fileman_PRE = list of file man page files set by calling Makefile.am
fileman_DATA = $(fileman_PRE:man=$(FILE_MAN_SUFFIX))

# The calling Makefile should only contain man page targets
# Otherwise the following three global variables may conflict
EXTRA_DIST = $(appman_PRE) $(driverman_PRE) $(fileman_PRE)
CLEANFILES = $(appman_DATA) $(driverman_DATA) $(fileman_DATA)
SUFFIXES = .$(APP_MAN_SUFFIX) .$(DRIVER_MAN_SUFFIX) .$(FILE_MAN_SUFFIX) .man

# Add server specific man pages string substitution from XORG_MANPAGE_SECTIONS
# 's|/,|/, |g' will add a space to help font path formatting
MAN_SUBSTS += -e 's|__logdir__|$(logdir)|g' \
-e 's|__datadir__|$(datadir)|g' \
-e 's|__mandir__|$(mandir)|g' \
-e 's|__sysconfdir__|$(sysconfdir)|g' \
-e 's|__xconfigdir__|$(__XCONFIGDIR__)|g' \
-e 's|__xkbdir__|$(XKB_BASE_DIRECTORY)|g' \
-e 's|__laucnd_id_prefix__|$(LAUNCHD_ID_PREFIX)|g' \
-e 's|__modulepath__|$(DEFAULT_MODULE_PATH)|g' \
-e 's|__default_font_path__|$(COMPILEDDEFAULTFONTPATH)|g' \
-e '\|$(COMPILEDDEFAULTFONTPATH)| s|/,|/, |g'

.man.$(APP_MAN_SUFFIX):
$(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
.man.$(DRIVER_MAN_SUFFIX):
$(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
.man.$(FILE_MAN_SUFFIX):
$(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@

0 comments on commit 885a333

Please sign in to comment.