Bug 30975

Summary: request for minor clarification of example in the fdp-primer
Product: Documentation Reporter: Giorgos Keramidas <charon>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
patch none

Description Giorgos Keramidas 2001-10-02 01:20:00 UTC 
	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 :-)
Comment 1 Bruce A. Mah freebsd_committer freebsd_triage 2001-10-02 01:30:40 UTC 
If memory serves me right, Giorgos Keramidas wrote:

> -	<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>,

Hmmm...it didn't mention pdf or ps?  KNOWN_FORMATS in doc/share/mk/
doc.docbook.mk lists several other formats as well, don't know how many 
of these actually work.

Bruce.
Comment 2 Giorgos Keramidas 2001-10-02 02:22:03 UTC 
Bruce A. Mah <bmah@FreeBSD.ORG> wrote:
> If memory serves me right, Giorgos Keramidas wrote:
> 
> > -	<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>,
> 
> Hmmm...it didn't mention pdf or ps?  KNOWN_FORMATS in doc/share/mk/
> doc.docbook.mk lists several other formats as well, don't know how many 
> of these actually work.

No, it does not mention any other formats.  Anyway, a pointer to
doc.docbook.mk for finding out about those other formats, and an example of
building multiple formats with FORMATS="x y z" seems more proper.
Do you want me to update the diff of this PR, to add the reference to
doc.docbook.mk ?

-giorgos
Comment 3 Bruce A. Mah freebsd_committer freebsd_triage 2001-10-02 06:03:42 UTC 
If memory serves me right, Giorgos Keramidas wrote:

> No, it does not mention any other formats.  Anyway, a pointer to
> doc.docbook.mk for finding out about those other formats, and an example of
> building multiple formats with FORMATS="x y z" seems more proper.
> Do you want me to update the diff of this PR, to add the reference to
> doc.docbook.mk ?

Sorry, I was perhaps more terse than I should have been.  It's probably
fine to just mention PS and PDF as possible formats along with the
rest....the list of formats rarely changes.

Bruce.
Comment 4 Murray Stokely freebsd_committer freebsd_triage 2001-10-02 07:00:32 UTC 
State Changed
From-To: open->closed

I applied the patch and then made the changes suggested in the audit 
trail.  Thanks!