Date: Tue, 3 Apr 2001 18:40:03 -0700 (PDT) From: Dima Dorfman <dima@unixfreak.org> To: freebsd-doc@freebsd.org Subject: Re: docs/26293: Just add detail on the tutorial Message-ID: <200104040140.f341e3w77414@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
The following reply was made to PR docs/26293; it has been noted by GNATS.
From: Dima Dorfman <dima@unixfreak.org>
To: Brian Somers <brian@Awfulhak.org>
Cc: jrcharron@gen-int.com, freebsd-gnats-submit@freebsd.org
Subject: Re: docs/26293: Just add detail on the tutorial
Date: Tue, 03 Apr 2001 18:38:24 -0700
Brian Somers <brian@Awfulhak.org> writes:
> > Can [!include] appear *with* indents, though? I don't want to screw people
> > over trying to use that. If it can appear either way, then it's
> > probably not worth mentioning it (bloat). If it must appear without
> > indents, a small notice somewhere may be in order so we people don't
> > pull their hair out because of that..
>
> !include isn't allowed with indents :-/
Okay. Here's an updated patch. I've tried to make them as
unintrusive as possible, but even if it is a little confusing it'll at
least make the person pay attention to indentation (and give them
something to read/research if they can't figure out why it doesn't
work).
Regards,
Dima Dorfman
dima@unixfreak.org
Index: ppp.conf.sample
===================================================================
RCS file: /st/src/FreeBSD/src/share/examples/ppp/ppp.conf.sample,v
retrieving revision 1.22
diff -u -r1.22 ppp.conf.sample
--- ppp.conf.sample 2000/12/01 11:52:22 1.22
+++ ppp.conf.sample 2001/04/04 01:35:18
@@ -11,7 +11,9 @@
# This file is separated into sections. Each section is named with
# a label starting in column 0 and followed directly by a ``:''. The
# section continues until the next section. Blank lines and lines
-# beginning with ``#'' are ignored.
+# beginning with ``#'' are ignored. All commands inside sections that do
+# not begin with ``!'' (e.g., ``!include'') *must* be indented by at least
+# one space or tab or they will not be recognized!
#
# Lines beginning with "!include" will ``include'' another file. You
# may want to ``!include ~/.ppp.conf'' for backwards compatibility.
Index: book.sgml
===================================================================
RCS file: /st/src/FreeBSD/doc/en_US.ISO_8859-1/books/ppp-primer/book.sgml,v
retrieving revision 1.6
diff -u -r1.6 book.sgml
--- book.sgml 2001/01/17 07:22:10 1.6
+++ book.sgml 2001/04/04 01:35:30
@@ -772,6 +772,16 @@
<para>Below is the /etc/ppp/ppp.conf file that we'll be using to provide a
dial-out Internet gateway for our example LAN:
+
+<note>
+ <para>The full syntax for <filename>ppp.conf</filename> is described in
+ &man.ppp.8;. Particuarly, note that any line that isn't a label that
+ ends with a colon (e.g., <literal>default:</literal>,
+ <literal>interactive:</literal>), a command that begins with
+ <quote>!</quote> (e.g., <literal>!include</literal>), or a comment
+ <emphasis>must</emphasis> be indented!</para>
+</note>
+
<programlisting>
################################################################
# PPP Configuration File ('/etc/ppp/ppp.conf')
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?200104040140.f341e3w77414>