luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-08-31 05:14:11 +02:00
Code Issues Packages Projects Releases Wiki Activity

Clean up man page handling

Browse Source 
Remove all formatted man pages from git, and use the same
Makefile fragment in all doc dirs.
This commit is contained in:
Matthias Clasen
2010-05-21 22:28:42 -04:00
parent d818bebf49
commit 8db946fdfb
11 changed files with 48 additions and 1252 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/reference/glib/Makefile.am
View File

@@ -93,18 +93,32 @@ man_MANS = \
glib-gettextize.1 \
gtester.1 \
gtester-report.1
if ENABLE_MAN
%.1 : %.xml
@XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
.xml.1:
XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
dist-local-check-mans-enabled:
if grep "Man generation disabled" $(man_MANS) >/dev/null; then $(RM) $(man_MANS); fi
else
$(man_MANS):
echo Man generation disabled. Creating dummy $@. Configure with --enable-man to enable it.
echo Man generation disabled. Remove this file, configure with --enable-man, and rebuild > $@
dist-local-check-mans-enabled:
echo "*** --enable-man must be used in order to make dist"
false
endif
BUILT_EXTRA_DIST = $(man_MANS)
MAINTAINERCLEANFILES = $(man_MANS) $(BUILT_SOURCES)
dist-hook-local: $(BUILT_EXTRA_DIST)
files='$(BUILT_EXTRA_DIST)'; \
for f in $$files; do \
if test -f $$f; then d=.; else d=$(srcdir); fi; \
cp $$d/$$f $(distdir) || exit 1; done
EXTRA_DIST += $(man_MANS)
dist-hook-local: dist-local-check-mans-enabled glib-docs-clean all-local
glib-docs-clean: clean
cd $(srcdir) && rm -rf xml html

71
docs/reference/glib/glib-gettextize.1
View File

@@ -1,71 +0,0 @@
'\" t
.\" Title: glib-gettextize
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 04/19/2010
.\" Manual: User Commands
.\" Source: User Commands
.\" Language: English
.\"
.TH "GLIB\-GETTEXTIZE" "1" "04/19/2010" "User Commands" "User Commands"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
glib-gettextize \- gettext internationalization utility
.SH "SYNOPSIS"
.HP \w'\fBglib\-gettextize\fR\ 'u
\fBglib\-gettextize\fR [option...] [directory]
.SH "DESCRIPTION"
.PP
\fBglib\-gettextize\fR
helps to prepare a source package for being internationalized through
gettext\&. It is a variant of the
\fBgettextize\fR
that ships with
gettext\&.
.PP
\fBglib\-gettextize\fR
differs from
\fBgettextize\fR
in that it doesn\'t create an
intl/
subdirectory and doesn\'t modify
po/ChangeLog
(note that newer versions of
\fBgettextize\fR
behave like this when called with the
\fB\-\-no\-changelog\fR
option)\&.
.SS "Options"
.PP
\fB\-\-help\fR
.RS 4
print help and exit
.RE
.PP
\fB\-\-version\fR
.RS 4
print version information and exit
.RE
.PP
\fB\-c\fR, \fB\-\-copy\fR
.RS 4
copy files instead of making symlinks
.RE
.PP
\fB\-f\fR, \fB\-\-force\fR
.RS 4
force writing of new files even if old ones exist
.RE
.SH "SEE ALSO"
.PP
\fBgettextize\fR(1)

44
docs/reference/glib/gtester-report.1
View File

@@ -1,44 +0,0 @@
'\" t
.\" Title: gtester-report
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 04/19/2010
.\" Manual: User Commands
.\" Source: User Commands
.\" Language: English
.\"
.TH "GTESTER\-REPORT" "1" "04/19/2010" "User Commands" "User Commands"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
gtester-report \- test report formatting utility
.SH "SYNOPSIS"
.HP \w'\fBgtester\-report\fR\ 'u
\fBgtester\-report\fR [option...] [gtester\-log]
.SH "DESCRIPTION"
.PP
\fBgtester\-report\fR
is a script which converts the XML output generated by gtester into HTML\&.
.SS "Options"
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
print help and exit
.RE
.PP
\fB\-v\fR, \fB\-\-version\fR
.RS 4
print version information and exit
.RE
.SH "SEE ALSO"
.PP
\fBgtester\fR(1)

101
docs/reference/glib/gtester.1
View File

@@ -1,101 +0,0 @@
'\" t
.\" Title: gtester
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 04/19/2010
.\" Manual: User Commands
.\" Source: User Commands
.\" Language: English
.\"
.TH "GTESTER" "1" "04/19/2010" "User Commands" "User Commands"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
gtester \- test running utility
.SH "SYNOPSIS"
.HP \w'\fBgtester\fR\ 'u
\fBgtester\fR [option...] [testprogram]
.SH "DESCRIPTION"
.PP
\fBgtester\fR
is a utility to run unit tests that have been written using the GLib test framework\&.
.PP
When called with the
\fB\-o\fR
option,
\fBgtester\fR
writes an XML report of the test results, which can be converted into HTML using the
\fBgtester\-report\fR
utility\&.
.SS "Options"
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
print help and exit
.RE
.PP
\fB\-v\fR, \fB\-\-version\fR
.RS 4
print version information and exit
.RE
.PP
\fB\-\-g\-fatal\-warnings\fR
.RS 4
make warnings fatal
.RE
.PP
\fB\-k\fR, \fB\-\-keep\-going\fR
.RS 4
continue running after tests failed
.RE
.PP
\fB\-l\fR
.RS 4
list paths of available test cases
.RE
.PP
\fB\-m=\fR\fB\fIMODE\fR\fR
.RS 4
run test cases in
\fIMODE\fR, which can be perf, slow, thorough or quick\&. The default mode is quick\&.
.RE
.PP
\fB\-p=\fR\fB\fITESTPATH\fR\fR
.RS 4
only run test cases matching
\fITESTPATH\fR
.RE
.PP
\fB\-\-seed=\fR\fB\fISEEDSTRING\fR\fR
.RS 4
run all test cases with random number seed
\fISEEDSTRING\fR
.RE
.PP
\fB\-o=\fR\fB\fILOGFILE\fR\fR
.RS 4
write the test log to
\fILOGFILE\fR
.RE
.PP
\fB\-q\fR, \fB\-\-quiet\fR
.RS 4
suppress per test binary output
.RE
.PP
\fB\-\-verbose\fR
.RS 4
report success per testcase
.RE
.SH "SEE ALSO"
.PP
\fBgtester-report\fR(1)