Commit graph

40 commits

Author SHA1 Message Date
Mark Linimon
f46cec4513 Add the 'usb' PR category. While here, clarify the use of the 'java'
category and change the master list of categories to point the CVSweb
location, which should always have the latest list.

Spurred by email from:		obrien
2005-01-15 02:16:42 +00:00
Hiroki Sato
c4cb2201ad Use lower-case characters for attribute name (s/URL=/url=/).
No content change.
2004-08-09 19:49:18 +00:00
Hiroki Sato
5fa082b1f8 Simplify parameter entities in doctype declaration.
Currently we have articles.ent and books.ent, and
for example, articles.ent can be used by putting the
following lines in the doctype declaration:

 <!ENTITY % articles.ent PUBLIC
            "-//FreeBSD//ENTITIES DocBook FreeBSD Articles Entity Set//EN">
 %articles.ent;

This pulls all of the necessary entities via share/sgml/articles.ent.

The translation teams can customize these entities by redefining
the articles.ent file in <langcode>/share/sgml.  See
ja_JP.eucJP/share/sgml for example.
2004-08-08 13:44:01 +00:00
Denis Peplin
c12c11040e Use url entities for links between docs 2004-08-05 10:04:31 +00:00
Denis Peplin
59859e64cb Close / fix pair tags 2004-07-06 14:25:55 +00:00
Mark Linimon
652d8b96e1 Whitespace changes needed after recent commits (and some additional
ones that were needed).  Translators may safely ignore.

Approved by:	ceri (mentor) (implicit)
2004-05-24 04:12:43 +00:00
Mark Linimon
8b1f3f8e28 Change occurences of FreeBSD to &os; since I brought in those entities
with my most recent changes.

Suggested by:	keramida
Approved by:	ceri (mentor) (implicitly)
2004-05-24 04:02:46 +00:00
Mark Linimon
3cb0ed22ac Rewrite the section on what information needs to be supplied to make
a good Problem Report.  Add pointers to the new files ports/CHANGES
and ports/UPDATING.  Change some occurrences of FreeBSD to &os; if
they were in the affected lines (another commit will do the remaining
ones).  Suggest guidelines for the often-abused Severity and Priority
fields.  Add a pointer to the categories definition file.  Add the
'threads' category.  Add a warning to include the tracking number on
followups to save creating new, bogus, PRs.

PR:		docs/67062
Reviewed by:	ceri, keramida, others
Approved by:	ceri (mentor)
2004-05-23 22:32:55 +00:00
Alexey Zelkin
6d048e2320 Sync these Makefiles to have one style of declarations and comments. 2004-04-06 16:10:08 +00:00
Simon L. B. Nielsen
4071843a8a Add trademark attribution for CVSup. 2003-12-24 00:26:41 +00:00
Simon L. B. Nielsen
a9e3afd078 Add trademark symbols and attributions:
- Add trademark tags as needed, generally on first use in each
   article.
 - Add an attribution to the legal section mentioning all trademarks
   referenced.
 - Always use correct case for trademarks.
2003-08-14 19:54:05 +00:00
Tom Rhodes
a9a59509d9 Most committers like patches to CURRENT over STABLE. Make a note of that.
Reviewed by:	ceri, simon
2003-08-11 21:17:34 +00:00
Christian Brueffer
e7c1439200 Add the amd64 gnats category 2003-06-22 21:40:40 +00:00
Giorgos Keramidas
f917b7ad98 - Update parts of this article and add a new "Tips and tricks for
writing a good problem report" section.
- Fix a few typos.
- Add a link to the searchable gnats database at FreeBSD.org.
- Point the users at /usr/src/UPDATING for more info before sending PRs.
- Be more verbose about patches and inline inclusion of diffs in a PR.
- Emphasize the importance of Class: maintainer-update and the use of
  "[maintainer update]"
- Describe what "[patch]" in synopsis lines means now that it's
  commonly used to help people who read PR indexes.

Submitted by:	Mark Linimon <linimon@lonesome.com>
2003-05-10 14:02:32 +00:00
Hiroki Sato
f6cd99b654 Back out WITH_DOCFORMAT_NAVI_LINK?=YES in Makefile. The navi-link
is generated when ${WITH_DOCFORMAT_NAVI_LINK} is defined or
${FORMATS} includes "html" and "html-split."
2003-04-22 18:35:44 +00:00
Hiroki Sato
4f8b26641c - Add WITH_DOCFORMAT_NAVI_LINK to mk/doc.docbook.mk and
enable it in en_US.ISO8859-1/ and ja_JP.eucJP/.

- Add PUBLIC "-//FreeBSD//ENTITIES DocBook Language Specific Entities//EN"
  and l10n.ent for entity localization.

- Use share/misc/docbook.css for indentiation of <programlisting>
  and <screen>.

- Add some missing $FreeBSD$.
2003-04-19 11:39:30 +00:00
Dag-Erling Smørgrav
9dbfa73c50 Some clarifications regarding patches in PRs. 2003-03-18 14:45:01 +00:00
Hiroki Sato
ee5bf07c5d Replace ${JADEFLAGS} with the corresponding variables. 2003-02-16 14:59:48 +00:00
Dag-Erling Smørgrav
23cba8b041 Whitespace cleanup + use <section> instead of <sect[12]>.
Translators can safely ignore this commit.
2003-02-04 23:11:18 +00:00
Dag-Erling Smørgrav
eaa733d19f Add a reference to the pr-guidelines article. 2003-02-04 23:08:54 +00:00
Giorgos Keramidas
52ce212a52 Expand contractions. 2002-09-01 19:57:05 +00:00
Giorgos Keramidas
687c734ca1 Whitespace-only change: wrap long lines. 2002-09-01 19:54:24 +00:00
Giorgos Keramidas
bdf7744707 Add link to mailing list descriptions, and a second link
to the searchable FreeBSD archives on the web.
2002-09-01 19:51:49 +00:00
Chern Lee
f1261c55fc Mention where to find an answer if it is not a bug, but a question.
PR:		docs/41003
Submitted by:	Adam Weinberger <adam@vectors.cx>
2002-07-29 11:24:14 +00:00
Marc Fonvieille
f48b11fb6e Add missing PowerPC category to the send-pr template
PR:		docs/40955
Submitted by:	Christian Brueffer <chris@unixpages.org>
2002-07-24 14:28:08 +00:00
Tom Rhodes
d4b003e30a FreeBSD documentation project prefers to use manual pages over man pages,
hence some documents should reflect this.

Tossed around on: -doc -developers
2002-07-11 19:08:31 +00:00
Jun Kuriyama
33803c4799 Unbreak (s@<literal>@</literal>@). 2002-07-11 00:04:54 +00:00
Dag-Erling Smørgrav
04e003109e Catch up with new Gnats categories.
Submitted by:	Hiten Pandya <hiten@uk.FreeBSD.org>
2002-07-10 22:11:31 +00:00
Bruce A. Mah
30c1821d70 Minor fixes in problem-reports article:
punctuation fixes s/;/,/
	addition of application tags and username tags

PR:		38847
Submitted by:	Marc Fonvieille <marc@blackend.org>
2002-06-11 00:48:55 +00:00
Giorgos Keramidas
d19554d5ca Remove extraneous whitespace. Also wrap </screen> to avoid space
between the closing tag and its contents.  This change can be ignored
by the translators.

PR:		docs/38849 (partially)
Submitted by:	Marc Fonvieille <marc@blackend.org>
2002-06-05 23:31:54 +00:00
Ceri Davies
f5e699b1c5 Axe "you've" in favour of "you have" from doc/en_US.ISO8859-1 where it's
not part of a quote.

Inspired by:	Arthur Munn <amunn@comcast.net>
2002-05-24 08:20:39 +00:00
Dag-Erling Smørgrav
a24fa9bc27 Remove unused external entity declarations. 2002-01-20 22:30:35 +00:00
Dag-Erling Smørgrav
55ea6e906b Convert a hyphen to &mdash; 2001-12-17 15:33:46 +00:00
Peter Pentchev
cdcc580f5a Add a 'Further Reading' section.
In this section, add a link to Simon G. Tatham's essay on writing
bug reports.

Approved by:	des, silence on -doc
2001-11-25 14:42:29 +00:00
Dag-Erling Smørgrav
03db593c2a Add a paragraph explaining that patches are assumed to be under the
same license as the files they modify.
2001-11-23 21:13:13 +00:00
Dag-Erling Smørgrav
247e04f88c More typo and markup fixes.
Submitted by:	keramidas.
2001-11-23 15:47:17 +00:00
Dag-Erling Smørgrav
027e0c2897 Remove all trailing whitespace. 2001-11-23 02:18:41 +00:00
Dag-Erling Smørgrav
71749510f6 Fix typos and markup nits.
Submitted by:	cmc, tmm
2001-11-23 02:15:00 +00:00
Dag-Erling Smørgrav
79ef787404 It's "problem report", not "bug report". I changed it everywhere else, but
missed the one in the title...
2001-11-23 01:19:09 +00:00
Dag-Erling Smørgrav
5b87f035a6 Add an article about writing good problem reports. It's a little thin in
places, but I think it's a good start.  I'll connect it to the build once
it's been reviewed by the appropriate people.
2001-11-23 01:01:51 +00:00