[140263] trunk/doc-new
raimue at macports.org
raimue at macports.org
Tue Sep 15 09:58:39 PDT 2015
Revision: 140263
https://trac.macports.org/changeset/140263
Author: raimue at macports.org
Date: 2015-09-15 09:58:39 -0700 (Tue, 15 Sep 2015)
Log Message:
-----------
doc-new: Remove outdated man page directory
Update Makefile, move referenced prefix hierarchy to guide.
Modified Paths:
--------------
trunk/doc-new/Makefile
trunk/doc-new/guide/xml/internals.xml
Added Paths:
-----------
trunk/doc-new/guide/xml/internals-hier.xml
Removed Paths:
-------------
trunk/doc-new/man/
Modified: trunk/doc-new/Makefile
===================================================================
--- trunk/doc-new/Makefile 2015-09-15 16:48:10 UTC (rev 140262)
+++ trunk/doc-new/Makefile 2015-09-15 16:58:39 UTC (rev 140263)
@@ -1,6 +1,6 @@
# $Id$
-# Makefile to generate the MacPorts HTML guide and the man pages.
+# Makefile to generate the MacPorts HTML guide pages.
# The ports 'docbook-xsl', 'docbook-xml' and 'libxslt' have to be installed.
# For the guide-dblatex target, the 'dblatex' port is also required.
@@ -31,17 +31,12 @@
# Data directories.
GUIDE = guide
-MAN = man
# Source directories.
GUIDE_SRC = $(GUIDE)/xml
-MAN_SRC = $(MAN)/xml
# Result directories.
GUIDE_RESULT = $(GUIDE)/html
GUIDE_RESULT_CHUNK = $(GUIDE_RESULT)/chunked
GUIDE_RESULT_DBLATEX = $(GUIDE)/dblatex
-MAN_RESULT = $(MAN)/man/
-# Man temporary directory.
-MAN_TMP = $(MAN)/tmp
# Path to the DocBook XSL files.
DOCBOOK = $(PREFIX)/share/xsl/docbook-xsl
@@ -50,14 +45,13 @@
endif
GUIDE_XSL = $(GUIDE)/resources/single-page.xsl
GUIDE_XSL_CHUNK = $(GUIDE)/resources/chunk.xsl
-MAN_XSL = $(MAN)/resources/macports.xsl
# DocBook HTML stylesheet for the guide.
STYLESHEET = docbook.css
-.PHONY: all guide guide-chunked guide-dblatex man clean validate
+.PHONY: all guide guide-chunked guide-dblatex clean validate
-all: guide guide-chunked man
+all: guide guide-chunked
# Generate the HTML guide using DocBook from the XML sources in $(GUIDE_SRC).
guide:
@@ -125,45 +119,11 @@
--output="$(GUIDE_RESULT_DBLATEX)/macports-guide.$(SUFFIX)" \
$(GUIDE_SRC)/guide.xml
-# Generate the man pages using DocBook from the XML source in $(MAN_SRC).
-# The portfile-*.xml and portgroup-*.xml files in $(GUIDE_SRC) are copied to
-# $(MAN_TMP) and modified (section -> refsection) so they can be used as man
-# XML source files and then xincluded in the real man XML files in $(MAN_SRC).
-man: $(MAN_XSL)
- $(MKDIR) -p $(MAN_RESULT)
- $(MKDIR) -p $(MAN_TMP)
- $(CP) $(GUIDE_SRC)/portfile-*.xml $(MAN_TMP)
- $(CP) $(GUIDE_SRC)/portgroup-*.xml $(MAN_TMP)
-ifeq ($(UNAME), Linux)
- $(SED) -i -r -e 's|<section|<refsection|g' $(MAN_TMP)/*
- $(SED) -i -r -e 's|</section>|</refsection>|g' $(MAN_TMP)/*
-else
- $(SED) -i "" 's|<section|<refsection|g' $(MAN_TMP)/*
- $(SED) -i "" 's|</section>|</refsection>|g' $(MAN_TMP)/*
-endif
- $(XSLTPROC) --xinclude --output $(MAN_RESULT) $(MAN_XSL) \
- $(MAN_SRC)/port.1.xml \
- $(MAN_SRC)/portfile.7.xml \
- $(MAN_SRC)/portgroup.7.xml \
- $(MAN_SRC)/porthier.7.xml
- $(RM) -r $(MAN_TMP)
-
-# Create XSL from template for man pages.
-$(MAN_XSL):
-ifeq ($(UNAME), Linux)
- $(SED) -r -e 's:@PREFIX@:$(PREFIX):' $@.in > $@
-else
- $(SED) 's:@PREFIX@:$(PREFIX):' $@.in > $@
-endif
-
-# Remove all temporary files generated by guide: and man:.
+# Remove all temporary files generated by guide:.
clean:
$(RM) -rf $(GUIDE)/resources/xsl
$(RM) -rf $(GUIDE_RESULT)
$(RM) -rf $(GUIDE_RESULT_DBLATEX)
- $(RM) -rf $(MAN_RESULT)
- $(RM) -rf $(MAN_TMP)
- $(RM) -rf $(MAN_XSL)
$(RM) -f guide.tmp.xml
# Validate the XML files for the guide.
Copied: trunk/doc-new/guide/xml/internals-hier.xml (from rev 140262, trunk/doc-new/man/xml/porthier.7.xml)
===================================================================
--- trunk/doc-new/guide/xml/internals-hier.xml (rev 0)
+++ trunk/doc-new/guide/xml/internals-hier.xml 2015-09-15 16:58:39 UTC (rev 140263)
@@ -0,0 +1,377 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<refentry id="porthier">
+ <refmeta>
+ <refentrytitle>PORTHIER</refentrytitle>
+
+ <manvolnum>7</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>porthier</refname>
+
+ <refpurpose>layout of the ports filesystems</refpurpose>
+ </refnamediv>
+
+ <refsection>
+ <title>Description</title>
+
+ <para>A map of the filesystem hierarchy used by MacPorts and the ports it
+ installs. Much of it is based on <citerefentry>
+ <refentrytitle>hier</refentrytitle>
+
+ <manvolnum>7</manvolnum>
+ </citerefentry>.</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><varname>${prefix}</varname></term>
+
+ <listitem>
+ <para>The base of the MacPorts filesystem hierarchy.</para>
+
+ <para>Default: <filename>/opt/local/</filename></para>
+
+ <variablelist>
+ <varlistentry>
+ <term><filename>bin/</filename></term>
+
+ <listitem>
+ <para>Common utilities, programming tools, and
+ applications.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <variablelist>
+ <varlistentry>
+ <term><filename>etc/</filename></term>
+
+ <listitem>
+ <para>System configuration files and scripts.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <variablelist>
+ <varlistentry>
+ <term><filename>include/</filename></term>
+
+ <listitem>
+ <para>Standard C include files.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <variablelist>
+ <varlistentry>
+ <term><filename>lib/</filename></term>
+
+ <listitem>
+ <para>Archive libraries.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <variablelist>
+ <varlistentry>
+ <term><filename>libexec/</filename></term>
+
+ <listitem>
+ <para>System daemons and system utilities (executed by other
+ programs).</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <variablelist>
+ <varlistentry>
+ <term><filename>Library/Frameworks/</filename></term>
+
+ <listitem>
+ <para>Native Mac OS X Library Frameworks</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <variablelist>
+ <varlistentry>
+ <term><filename>sbin/</filename></term>
+
+ <listitem>
+ <para>System programs and administration utilities.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <variablelist>
+ <varlistentry>
+ <term><filename>share/</filename></term>
+
+ <listitem>
+ <para>Architecture-independent files.</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><filename>doc/</filename></term>
+
+ <listitem>
+ <para>Miscellaneous documentation.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <variablelist>
+ <varlistentry>
+ <term><filename>examples/</filename></term>
+
+ <listitem>
+ <para>Examples for users and programmers.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <variablelist>
+ <varlistentry>
+ <term><filename>info/</filename></term>
+
+ <listitem>
+ <para>GNU Info hypertext system.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <variablelist>
+ <varlistentry>
+ <term><filename>locale/</filename></term>
+
+ <listitem>
+ <para>Localization files.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <variablelist>
+ <varlistentry>
+ <term><filename>man/</filename></term>
+
+ <listitem>
+ <para>Manual pages.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <variablelist>
+ <varlistentry>
+ <term><filename>misc/</filename></term>
+
+ <listitem>
+ <para>Miscellaneous system-wide ASCII text files.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>src/</filename></term>
+
+ <listitem>
+ <para>Source code.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>var/</filename></term>
+
+ <listitem>
+ <para>Multi-purpose log, temporary, transient and spool
+ files.</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><filename>db/</filename></term>
+
+ <listitem>
+ <para>Miscellaneous automatically generated
+ system-specific database files.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>macports/</filename></term>
+
+ <listitem>
+ <para>MacPorts package building topdir.</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><filename>build/</filename></term>
+
+ <listitem>
+ <para>Where ports are built and destrooted.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>distfiles/</filename></term>
+
+ <listitem>
+ <para>Storage location for the distfiles of fetched
+ ports.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>packages/</filename></term>
+
+ <listitem>
+ <para>Obsolete. Formerly contained archives (packages) of installed
+ ports.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>receipts/</filename></term>
+
+ <listitem>
+ <para>Obsolete. Formerly contained the registry information and receipts
+ for installed ports, in flat-file format.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>registry/</filename></term>
+
+ <listitem>
+ <para>Contains the registry database in sqlite format.</para>
+ </listitem>
+ </varlistentry>
+
+
+ <varlistentry>
+ <term><filename>software/</filename></term>
+
+ <listitem>
+ <para>The files for each installed port are stored here.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>sources/</filename></term>
+
+ <listitem>
+ <para>Holds the sources for the ports tree (the
+ Portfiles) and also MacPorts base.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <variablelist>
+ <varlistentry>
+ <term><filename>spool/</filename></term>
+
+ <listitem>
+ <para>Directory containing output spool files.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <variablelist>
+ <varlistentry>
+ <term><filename>log/</filename></term>
+
+ <listitem>
+ <para>Miscellaneous system log files.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <variablelist>
+ <varlistentry>
+ <term><filename>run/</filename></term>
+
+ <listitem>
+ <para>System information files describing various
+ information about the system since it was booted.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>www/</filename></term>
+
+ <listitem>
+ <para>Files to be served by an http server.</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><filename>cgi-bin/</filename></term>
+
+ <listitem>
+ <para>Directory for cgi executables.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <variablelist>
+ <varlistentry>
+ <term><filename>/Applications/MacPorts/</filename></term>
+
+ <listitem>
+ <para>Native Mac OS X applications.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsection>
+
+ <refsection>
+ <title>SEE ALSO</title>
+
+ <para><citerefentry>
+ <refentrytitle>port</refentrytitle>
+
+ <manvolnum>1</manvolnum>
+ </citerefentry>, <citerefentry>
+ <refentrytitle>macports.conf</refentrytitle>
+
+ <manvolnum>5</manvolnum>
+ </citerefentry>, <citerefentry>
+ <refentrytitle>portfile</refentrytitle>
+
+ <manvolnum>7</manvolnum>
+ </citerefentry>, <citerefentry>
+ <refentrytitle>portgroup</refentrytitle>
+
+ <manvolnum>7</manvolnum>
+ </citerefentry>, <citerefentry>
+ <refentrytitle>portstyle</refentrytitle>
+
+ <manvolnum>7</manvolnum>
+ </citerefentry>, <citerefentry>
+ <refentrytitle>hier</refentrytitle>
+
+ <manvolnum>7</manvolnum>
+ </citerefentry></para>
+ </refsection>
+
+ <refsection>
+ <title>AUTHORS</title>
+
+ <para>Felix Kroniage <email>fkr at opendarwin.org</email></para>
+
+ <para>Juan Manuel Palacios <email>jmpp at macports.org</email></para>
+ </refsection>
+</refentry>
Modified: trunk/doc-new/guide/xml/internals.xml
===================================================================
--- trunk/doc-new/guide/xml/internals.xml 2015-09-15 16:48:10 UTC (rev 140262)
+++ trunk/doc-new/guide/xml/internals.xml 2015-09-15 16:58:39 UTC (rev 140263)
@@ -11,7 +11,7 @@
<section id="internals.hierarchy">
<title>File Hierarchy</title>
- <xi:include href="../../man/xml/porthier.7.xml"
+ <xi:include href="internals-hier.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/macports-changes/attachments/20150915/2d58bce7/attachment-0001.html>
More information about the macports-changes
mailing list