From andrey at smagin.com  Fri Feb  7 06:05:28 2003
From: andrey at smagin.com (Andrey Smagin)
Date: Thu, 6 Feb 2003 23:05:28 -0600
Subject: minor fixes for "doc/en/faq/book.sgml"
Message-ID: <20030206230528.10e52a8e.andrey@smagin.com>

Hello.

Here is a small patch to consider:
 fixes several typos;
 lt --> &lt;
 some wording improvements.

Since I currently reside in the USA, I naturally wanted to replace
'organisation' with 'organization', etc. :)

I noticed that 'organisation' and 'customise' are mostly spelled
with 's', but 'familiarize' - with 'z'. Also, both color and colour
are used throughout the code. I think it would be better to choose
one dialect of English and stick to it for the sake of consistency.

Do you prefer British or American English?

Best regards,
Andrey

P.S. Does this list allow attachments?


Index: en/faq/book.sgml
===================================================================
RCS file: /build/tendra/repository/cvs/doc/en/faq/book.sgml,v
retrieving revision 1.5
diff -u -r1.5 book.sgml
--- en/faq/book.sgml	2 Feb 2003 22:36:42 -0000	1.5
+++ en/faq/book.sgml	7 Feb 2003 04:29:37 -0000
@@ -53,7 +53,7 @@
         <answer>
           <para><acronym>ANDF</acronym> stands for
         <emphasis>Architectural Neutral Distribution Format</emphasis>,
-        a format designed to improve portability and distribtution of
+        a format designed to improve portability and distribution of
         software. <acronym>TDF</acronym> stands for <emphasis>Ten15
         Distribution Format</emphasis> (though it has more recently
         become known just as the <emphasis>TenDRA Distribution
@@ -232,7 +232,7 @@
         technology for instance. Another point of motivation is the fact
         that TenDRA is a <ulink
         url="http://www.tendra.org/licenses/BSDL.txt">BSD-licensed</ulink>
-        compiler, which we consider an asset. Finally, everone has their
+        compiler, which we consider an asset. Finally, everyone has their
         own reasons, but the above is a fair representation of interests
         shared by all developers.
           </para>
@@ -335,14 +335,14 @@
 
           <para>Some understanding of how the system works is useful in trying
             to work around problems. The start-up files describing the
-            macros needed to nagivate the system headers for a particular
+            macros needed to navigate the system headers for a particular
             API are found in:
             <filename class="directory">src/lib/machines/&lt;os&gt;/&lt;cpu&gt;/startup/&lt;api&gt;.h</filename>
             where &lt;os&gt; is the operating system name, &lt;cpu&gt; is
             the CPU type, and &lt;api&gt; is the API name. A set of
             replacement system headers, which are checked before the real
-            system headers, are found in:
-            <filename class="directory">src/lib/machines/&lt;os&gt;/lt;cpu&gt;/include</filename>
+            system headers, can be found in:
+            <filename class="directory">src/lib/machines/&lt;os&gt;/&lt;cpu&gt;/include</filename>.
             These are also used with the -Ysystem option to tcc,
             modifications which are specific to library building, should be
             enclosed in:</para>
@@ -353,11 +353,11 @@
 #endif
           </programlisting>
 
-          <para>Good places to look for inspiration on how to customise these
-            files for your particular system include looking to see how
-            I've done things in similar circumstances. Often a problem
-            crops up on more than one machine; I may have a workround which
-            works on another platform which you can steal.</para>
+          <para>A good way to look for inspiration on how to customise these
+            files for your particular system is to check how it was done
+	    for other systems in similar circumstances. Often a problem crops
+	    up on more than one machine - there may be already a workaround
+	    implemented for another platform which you can use as a reference.</para>
 
           <para>If you don't intend to re-distribute the TenDRA source code you
             also have an option which, for copyright reasons, is not


From andrey at smagin.com  Fri Feb  7 07:02:34 2003
From: andrey at smagin.com (Andrey Smagin)
Date: Fri, 7 Feb 2003 00:02:34 -0600
Subject: diff for doc/en/diag/book.sgml
Message-ID: <20030207000234.5668cbe5.andrey@smagin.com>


Unless I am mistaken (which is quite posssible),
'contining' should be changed to 'containing'.
Added comma makes the sentence more readable (I think).

Regards,
Andrey


Index: en/diag/book.sgml
===================================================================
RCS file: /build/tendra/repository/cvs/doc/en/diag/book.sgml,v
retrieving revision 1.1
diff -u -r1.1 book.sgml
--- en/diag/book.sgml	7 Oct 2002 10:01:55 -0000	1.1
+++ en/diag/book.sgml	7 Feb 2003 05:58:35 -0000
@@ -373,7 +373,7 @@
 
         <para>An enumeration to be stored in an object of type
           <emphasis>base_type</emphasis>. If <emphasis>enum_name</emphasis> is
-          a string contining zero characters this signifies no source tag.</para>
+          a string containing zero characters, this signifies no source tag.</para>
 
       </sect2>
       <sect2>
@@ -462,7 +462,7 @@
         </programlisting>
 
         <para>Describes a structure. If <emphasis>src_name</emphasis> is a string
-          contining zero characters this signifies no source tag for the whole
+          containing zero characters, this signifies no source tag for the whole
           structure. <emphasis>tdf_shape</emphasis> allows the total size to be
           computed.</para>
 
@@ -494,7 +494,7 @@
         </programlisting>
 
         <para>Describes a union. If <emphasis>src_name</emphasis> is a string
-          contining zero characters this signifies no source tag for the whole
+          containing zero characters, this signifies no source tag for the whole
           union. <emphasis>tdf_shape</emphasis> allows the total size to be
           computed.</para>
 


From asmodai at wxs.nl  Fri Feb  7 07:39:34 2003
From: asmodai at wxs.nl (Jeroen Ruigrok/asmodai)
Date: Fri, 7 Feb 2003 07:39:34 +0100
Subject: Current docs
Message-ID: <20030207063934.GT43834@nexus.ninth-circle.org>

The current docs in the repository need to be checked on grammar nits,
bad/inconsistent formatting and the likes.

There's some fixes I committed to various docs already so please see the
repository through means as cvsweb or a local cvs repo.

Feel free to ask questions on this forum.

-- 
Jeroen Ruigrok van der Werven <asmodai(at)wxs.nl> / asmodai / Kita no Mono
Ninth Circle Enterprises | http://www.anti-dmca.org/
http://www.tendra.org/   | http://www.advogato.org/person/asmodai/
That's your Destiny, the only chance, take it, take it in your hands...


From asmodai at wxs.nl  Fri Feb  7 08:03:30 2003
From: asmodai at wxs.nl (Jeroen Ruigrok/asmodai)
Date: Fri, 7 Feb 2003 08:03:30 +0100
Subject: diff for doc/en/diag/book.sgml
In-Reply-To: <20030207000234.5668cbe5.andrey@smagin.com>
References: <20030207000234.5668cbe5.andrey@smagin.com>
Message-ID: <20030207070330.GU43834@nexus.ninth-circle.org>

-On [20030207 07:39], Andrey Smagin (andrey at smagin.com) wrote:
>Unless I am mistaken (which is quite posssible),
>'contining' should be changed to 'containing'.

Fixed.

>Added comma makes the sentence more readable (I think).

It doesn't unfortunately, because then you loose the implication which
the rest of the sentence incurs.  At least that's what I think now, I
know people are too much using commas nowadays.  I'll dig in some of my
English resources and come back on it. ;)

Thanks!

-- 
Jeroen Ruigrok van der Werven <asmodai(at)wxs.nl> / asmodai / Kita no Mono
Ninth Circle Enterprises | http://www.anti-dmca.org/
http://www.tendra.org/   | http://www.advogato.org/person/asmodai/
The last word in a chronicle is never set down...


From asmodai at wxs.nl  Fri Feb  7 08:17:47 2003
From: asmodai at wxs.nl (Jeroen Ruigrok/asmodai)
Date: Fri, 7 Feb 2003 08:17:47 +0100
Subject: minor fixes for "doc/en/faq/book.sgml"
In-Reply-To: <20030206230528.10e52a8e.andrey@smagin.com>
References: <20030206230528.10e52a8e.andrey@smagin.com>
Message-ID: <20030207071747.GW43834@nexus.ninth-circle.org>

-On [20030207 07:38], Andrey Smagin (andrey at smagin.com) wrote:
>Here is a small patch to consider:
> fixes several typos;
> lt --> &lt;
> some wording improvements.

Fixed.

>Do you prefer British or American English?

I need to look at some things wrt international English and get back to
you with a documentation style guide. :)

>P.S. Does this list allow attachments?

It does.

Committed, thanks! :)

-- 
Jeroen Ruigrok van der Werven <asmodai(at)wxs.nl> / asmodai / Kita no Mono
Ninth Circle Enterprises | http://www.anti-dmca.org/
http://www.tendra.org/   | http://www.advogato.org/person/asmodai/
The weak can never forgive. Forgiveness is the attribute of the strong...



From nonce at tendra.org  Sat Feb  8 03:16:00 2003
From: nonce at tendra.org (Amos B. Haven)
Date: Fri, 7 Feb 2003 18:16:00 -0800
Subject: diff for doc/en/diag/book.sgml
In-Reply-To: <20030207070330.GU43834@nexus.ninth-circle.org>
References: <20030207000234.5668cbe5.andrey@smagin.com> <20030207070330.GU43834@nexus.ninth-circle.org>
Message-ID: <20030208021600.GA76688@spill.tendra.org>

On Fri, Feb 07, 2003 at 08:03:30AM +0100, Jeroen Ruigrok/asmodai wrote:
> -On [20030207 07:39], Andrey Smagin (andrey at smagin.com) wrote:
> >Unless I am mistaken (which is quite posssible),
> >'contining' should be changed to 'containing'.
> 
> Fixed.
> 
> >Added comma makes the sentence more readable (I think).
> 
> It doesn't unfortunately, because then you loose the implication which
> the rest of the sentence incurs.  At least that's what I think now, I
> know people are too much using commas nowadays.  I'll dig in some of my
> English resources and come back on it. ;)

These are great suggestions, Andrey.  Keep them coming!

On the topic of commas, see:

   http://www.bartleby.com/141/strunk.html#5

which suggests "[d]o not join independent clauses by a comma."  But
then again, these documents are written by programmers for
programmers.  So using nested parens would be fine by me!  :)

-- 
ABH
nonce at tendra.org



From asmodai at wxs.nl  Sat Feb  8 22:50:11 2003
From: asmodai at wxs.nl (Jeroen Ruigrok/asmodai)
Date: Sat, 8 Feb 2003 22:50:11 +0100
Subject: Docs regenerated
Message-ID: <20030208215011.GI43834@nexus.ninth-circle.org>

I regenerated all the docs and put them online, both http and ftp.

-- 
Jeroen Ruigrok van der Werven <asmodai(at)wxs.nl> / asmodai / Kita no Mono
Ninth Circle Enterprises | http://www.anti-dmca.org/
http://www.tendra.org/   | http://www.advogato.org/person/asmodai/
Atone me to my throes curtail...



From asmodai at wxs.nl  Sun Feb  9 21:42:46 2003
From: asmodai at wxs.nl (Jeroen Ruigrok/asmodai)
Date: Sun, 9 Feb 2003 21:42:46 +0100
Subject: doc build stops
Message-ID: <20030209204246.GN43834@nexus.ninth-circle.org>

For some weird reason tld, tnc, and tspec all give an error code 1 at
the end of the PDF creation.

I am looking into it, but if people are bored and such, feel free to
look. :)

-- 
Jeroen Ruigrok van der Werven <asmodai(at)wxs.nl> / asmodai / Kita no Mono
Ninth Circle Enterprises | http://www.anti-dmca.org/
http://www.tendra.org/   | http://www.advogato.org/person/asmodai/
For wouldst thou not carve at my Soul with thine sword of Supreme Truth?



From andrey at smagin.com  Mon Feb 10 09:14:13 2003
From: andrey at smagin.com (Andrey Smagin)
Date: Mon, 10 Feb 2003 02:14:13 -0600
Subject: Current docs
In-Reply-To: <20030207063934.GT43834@nexus.ninth-circle.org>
References: <20030207063934.GT43834@nexus.ninth-circle.org>
Message-ID: <20030210021413.23a4e2e1.andrey@smagin.com>

On Fri, 7 Feb 2003 07:39:34 +0100
Jeroen Ruigrok/asmodai <asmodai at wxs.nl> wrote:

> The current docs in the repository need to be checked on grammar
> nits, bad/inconsistent formatting and the likes.

I would like to do that, little by little, unless there are any
objections from the developers.
 
> Feel free to ask questions on this forum.

After looking through the documentation, I have two questions:

Currently the most commonly used style in TenDRA docs and www is
2-space identation. Is it the recommended ident size?

Looking at the original version of pmake tutorial (which I found on my
own hard drive - doh! :) ) and new .sgml version, I noticed that
some of the formatting elements were lost - was it done on purpose, to
simplify the text? What if I add the missing elements, such as
<command>pmake -f blah</command>, <filename>*.c</filename>,  
<parameter class="option">-f</parameter>, <literal>{</literal> ?

--
Andrey

P.S. Jeroen, Amos - thanks for the timely commits of my small patches
- easier to work when my tree is in sync with the repository.


From andrey at smagin.com  Tue Feb 11 03:05:38 2003
From: andrey at smagin.com (Andrey Smagin)
Date: Mon, 10 Feb 2003 20:05:38 -0600
Subject: Current docs
In-Reply-To: <20030210021413.23a4e2e1.andrey@smagin.com>
References: <20030207063934.GT43834@nexus.ninth-circle.org>
	<20030210021413.23a4e2e1.andrey@smagin.com>
Message-ID: <20030210200539.214f6cfd.andrey@smagin.com>

> Currently the most commonly used style in TenDRA docs and www is
> 2-space identation. Is it the recommended ident size?

s/ident/indent/
ident-indent-intend-inetd... grr.. hate those words :)