Re: Developer manual update diff for checking

Ian Silvester <[email protected]> wrote:

> I've attached a diff of the updates I've made to the developer manual in
> the New Release - OS X section. Please could someone check it for
> buildability and correctness then let me know so that I may commit it.

1)
It doesn't build:

fk@mint ~/privoxy $ make dok
[...]
mkdir -p doc/source/developer-manual
cd doc/source/developer-manual && jade -c /usr/share/sgml/docbook/dtd/3.1/docbook.cat -ihtml -t sgml  -D.. -d ldp.dsl#html ../developer-manual.sgml && cd .. && cp developer-manual/*.html ../webserver/developer-manual/
jade:../developer-manual.sgml:2757:11:E: end tag for element "SECT3" which is not open
make: *** [dok-devel] Error 1

This can be fixed by removing the "</sect3>" added by the
last chunk of the patch.

2)
One trailing white-space. BTW, git can be configured to
highlight those when viewing commits.

3)
The indentation seems to be inconsistent compared to the
patch itself and its surrounding.

4)
The "paragraph" starting with "There are three modules ..."
is a single line when it probably should be three.

5)
Typos: "pacakge(s)", "on it's usage".

6)
Given that unlike the previous patch this one is intended
for technically at least somewhat adept users, I think all
the occurrences of "folder" should be replaced with "directory":
http://www.lemis.com/grog/Rant/bad-language.php#folder

If all Mac OS X users know what a directory is, it might
make sense to do it everywhere, but I'm aware that parts
of the OS X documentation already used the word "folder"
before your improvements.

Fabian

------------------------------------------------------------------------------
This SF email is sponsosred by:
Try Windows Azure free for 90 days Click Here 
http://p.sf.net/sfu/sfd2d-msazure

_______________________________________________
Ijbswa-developers mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/ijbswa-developers

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.18 (FreeBSD)

iEYEARECAAYFAk9iH/gACgkQSMVSH78upWNVTwCdEaYPxH0KQxlvlz71zWLR0UoN
LOwAn3Y11PkDrPZqPaLwXwgGevx5G/aa
=6xuC
-----END PGP SIGNATURE-----