mirrors/libguestfs
1
0
Fork 0
mirror of https://github.com/libguestfs/libguestfs.git synced 2026-03-21 22:53:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Move internal documentation to guestfs-hacking(1).

Browse Source 
All developer documentation should go in guestfs-hacking(1) and the
"internal documentation" (ie. documentation about internal functions
and interfaces) belongs here, not in the coincidentally synonymous
guestfs-internals(1).
This commit is contained in:
Richard W.M. Jones
2016-05-03 21:50:35 +01:00
parent bbec1b570b
commit a8114449fa
4 changed files with 23 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/Makefile.am
View File

@@ -97,22 +97,11 @@ stamp-guestfs-faq.pod: guestfs-faq.pod
guestfs-hacking.1 $(top_builddir)/website/guestfs-hacking.1.html: stamp-guestfs-hacking.pod
stamp-guestfs-hacking.pod: guestfs-hacking.pod
stamp-guestfs-hacking.pod: guestfs-hacking.pod internal-documentation.pod
$(PODWRAPPER) \
--section 1 \
--man guestfs-hacking.1 \
--html $(top_builddir)/website/guestfs-hacking.1.html \
--license LGPLv2+ \
$<
touch $@
guestfs-internals.1 $(top_builddir)/website/guestfs-internals.1.html: stamp-guestfs-internals.pod
stamp-guestfs-internals.pod: guestfs-internals.pod internal-documentation.pod
$(PODWRAPPER) \
--section 1 \
--man guestfs-internals.1 \
--html $(top_builddir)/website/guestfs-internals.1.html \
--insert internal-documentation.pod:__INTERNAL_DOCUMENTATION__ \
--license LGPLv2+ \
$<
@@ -128,6 +117,17 @@ internal-documentation.pod: $(source_files:%=$(top_srcdir)/%)
$(source_files)
mv $@-t $@
guestfs-internals.1 $(top_builddir)/website/guestfs-internals.1.html: stamp-guestfs-internals.pod
stamp-guestfs-internals.pod: guestfs-internals.pod
$(PODWRAPPER) \
--section 1 \
--man guestfs-internals.1 \
--html $(top_builddir)/website/guestfs-internals.1.html \
--license LGPLv2+ \
$<
touch $@
guestfs-performance.1 $(top_builddir)/website/guestfs-performance.1.html: stamp-guestfs-performance.pod
stamp-guestfs-performance.pod: guestfs-performance.pod

9
docs/guestfs-hacking.pod
View File

@@ -861,6 +861,15 @@ Optionally do a full release of the development branch.
=back
=head1 INTERNAL DOCUMENTATION
This section documents internal functions inside libguestfs and
various utilities. It is intended for libguestfs developers only.
These functions are not publicly exported, and may change or be
removed at any time.
__INTERNAL_DOCUMENTATION__
=head1 SEE ALSO
L<guestfs(3)>,

9
docs/guestfs-internals.pod
View File

@@ -397,15 +397,6 @@ on a platform that does support supermin using
L<libguestfs-make-fixed-appliance(1)>, copy it over, and use that
to run libguestfs.
=head1 INTERNAL DOCUMENTATION
This section documents internal functions inside libguestfs and
various utilities. It is intended for libguestfs developers only.
These functions are not publicly exported, and may change or be
removed at any time.
__INTERNAL_DOCUMENTATION__
=head1 SEE ALSO
L<guestfs(3)>,

4
docs/make-internal-documentation.pl
View File

@@ -33,7 +33,7 @@ make-internal-documentation.pl - Generate internal documentation from C files
=head1 DESCRIPTION
C<make-internal-documentation.pl> is a script that generates
L<guestfs-internals(1)/INTERNAL DOCUMENTATION>.
L<guestfs-hacking(1)/INTERNAL DOCUMENTATION>.
You must specify the name of the output file using the I<-o> or
I<--output> option, and a list of the C source files in the project.
@@ -233,7 +233,7 @@ exit 0;
=head1 SEE ALSO
L<perlpod(1)>,
L<guestfs-internals(1)>.
L<guestfs-hacking(1)>.
=head1 AUTHOR