Package: debian-handbook
Version: 6.0+20120509
Severity: minor

Hi Raphaƫl,
I've just completed chapter 7 and what follows is my list of proposed
changes, grouped by relevant section.


Section 7.1. Documentation Sources
----------------------------------

| but since these documentations are

As far as I know, the term "documentation" is uncountable in English.
Therefore I would   s/documentations/documents/


Section 7.1.4. Websites
-----------------------

http://freshmeat.net/
has been renamed and is now known as
http://freecode.com/

I think that the link should be updated...


Section 7.1.5. Tutorials (HOWTO)
--------------------------------

| A howto is a documentation

Again, since "documentation" in uncountable, I would
s/documentation/document/


| To view them locally, just install the doc-linux-html package. Local
| HTML versions will then be available in the /usr/share/doc/HOWTO/
| directory.

I would drop this paragraph entirely, since package doc-linux-html
has been recently removed from Debian (see bug #668078), hence
it's better not to recommend users to rely on it, or they will
have a bad surprise as soon as they upgrade to wheezy...


Section 7.2.1. Configuring a Program
------------------------------------

| example is specific to a particular architecture, it should be installed in
| /usr/lib/package/examples/ and you should create a link pointing to that
| file in the /usr/share/doc/package/examples/ directory.

This sentence is not especially clear to me: who is the "you" that should
create the link?
Since the chapter is teaching administrators to find useful documentation,
it may seem that the "you" mentioned in this sentence is an administrator
who installed the package.
But I am under the impression that this "you" is instead the package
maintainer, who should set things up so that the package installation
automatically creates the link.
If this is really the case, I would rephrase the sentence as follows:

+ example is specific to a particular architecture, it should be installed in
+ /usr/lib/package/examples/ and there should be a link pointing to that
+ file in the /usr/share/doc/package/examples/ directory.



--
To UNSUBSCRIBE, email to debian-bugs-dist-requ...@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmas...@lists.debian.org

Reply via email to