Date: Tue, 2 Oct 2001 01:16:58 +0300 (EEST) From: Giorgos Keramidas <charon@labs.gr> To: FreeBSD-gnats-submit@freebsd.org Subject: docs/30975: request for minor clarification of example in the fdp-primer Message-ID: <200110012216.f91MGw415224@hades.hell.gr>
next in thread | raw e-mail | index | archive | help
>Number: 30975
>Category: docs
>Synopsis: request for minor clarification of example in the fdp-primer
>Confidential: no
>Severity: non-critical
>Priority: low
>Responsible: freebsd-doc
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: doc-bug
>Submitter-Id: current-users
>Arrival-Date: Mon Oct 01 17:20:00 PDT 2001
>Closed-Date:
>Last-Modified:
>Originator: Giorgos Keramidas
>Release: FreeBSD 5.0-CURRENT i386
>Organization:
>Environment:
System: FreeBSD hades.hell.gr 5.0-CURRENT FreeBSD 5.0-CURRENT #5: Tue Sep 4
19:49:44 EEST 2001 root@hades.hell.gr:/usr/obj/usr/src/sys/CHARON i386
>Description:
I've been reading the fdp-primer book lately, paying a lot of
attention to more or less important details. There is one example of
building the docs, that I wanted to add a little clarification. The
patch shown below describes in more detail the use of the
FORMATS="..." make variable.
I'm not sure if this is good enough, but here it is :-)
>How-To-Repeat:
>Fix:
--- patch begins here ---
Index: en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml,v
retrieving revision 1.8
diff -u -r1.8 chapter.sgml
--- en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml 26 Sep 2001 21:49:28 -0000 1.8
+++ en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml 1 Oct 2001 22:16:19 -0000
@@ -247,11 +247,31 @@
and convert the document to other formats for review.</para>
<screen>&prompt.user; <userinput>make lint</userinput>
-&prompt.user; <userinput>make FORMATS=<replaceable>format</replaceable></userinput></screen>
+&prompt.user; <userinput>make FORMATS=<replaceable>format-list</replaceable></userinput></screen>
- <para>Where <replaceable>format</replaceable> is one of
+ <para>Where <replaceable>format-list</replaceable> is one of
<literal>html</literal>, <literal>html-split</literal>,
- <literal>txt</literal>, or <literal>rtf</literal></para>
+ <literal>txt</literal>, or <literal>rtf</literal>,
+ or a space-separated list of more than one of these.
+ Use quotes around the list of formats when you build more
+ than one format in one command.</para>
+
+ <para>For example, to convert the document to
+ <literal>html</literal> only, you would use:</para>
+
+ <screen>&prompt.user; <userinput>make FORMATS=html</userinput></screen>
+
+ <para>But when you want to convert the document to both
+ <literal>html</literal> and <literal>txt</literal> format,
+ you should use either two separate &man.make.1; runs,
+ with:</para>
+
+ <screen>&prompt.user; <userinput>make FORMATS=html</userinput>
+&prompt.user; <userinput>make FORMATS=txt</userinput></screen>
+
+ <para>or, you can do it in one command:</para>
+
+ <screen>&prompt.user; <userinput>make FORMATS="html txt"</userinput></screen>
</step>
<step>
--- patch ends here ---
>Release-Note:
>Audit-Trail:
>Unformatted:
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200110012216.f91MGw415224>