Commit graph

74 commits

Author SHA1 Message Date
Eitan Adler
de213994c7 Discourage feature requests from the existing GNATS implementation.
This may change in the future, but they do not get acted upon now.

Remove the alpha category as we no longer support such hardware.

Approved by:	bcr
2012-10-04 14:56:43 +00:00
Eitan Adler
5dce6e000a Get ready for a world without cvsup and CVS. While this won't happen
for some time it isn't a good idea to leave these references
lying around

Approved by:	bcr
2012-10-04 14:56:37 +00:00
Gabor Kovesdan
77d737ee88 - Rename the share/sgml directories to share/xml
- Fix build errors from the next change

Approved by:	doceng (implicit)
2012-10-01 11:56:00 +00:00
Gabor Kovesdan
b4346b9b2d - Rename .sgml files to .xml
- Reflect the rename in referencing files

Approved by:	doceng (implicit)
2012-10-01 09:53:01 +00:00
Gabor Kovesdan
9c243757ef - XML declarations should use IANA encoding names
Pointed out by:	hrs
2012-09-14 17:47:48 +00:00
Gabor Kovesdan
0421ffc179 - MFH
Approved by:	doceng (implicit)
2012-09-04 21:35:17 +00:00
Gabor Kovesdan
2e51ec7022 - Strip unnecessary trailing spaces
Approved by:	doceng (implicit)
2012-08-21 19:16:02 +00:00
Gabor Kovesdan
e6b69c3357 - XMLify English articles
Approved by:	doceng (implicit)
2012-06-21 16:01:00 +00:00
Gabor Pali
6fb170b309 - Spelling fixes
PR:		docs/149140
Submitted by:	olgeni
2010-07-31 11:06:18 +00:00
Remko Lodder
a157796182 Add some extra details to the article.
One whitespace move, because area was touched by
submitter.

PR:		130039
Submitted by:	gavin
2008-12-30 08:24:54 +00:00
Remko Lodder
a38313ad0b Final pass at making things right, because I didn't check properly.
Update all url's from the first commit that I did today to have
a space before the <link> and remove the space from within the link
so that it just looks good.

pointy hat:	remko
noticed by:	danger
2008-07-13 14:37:24 +00:00
Remko Lodder
33b990f6a0 s/http://www.freebsd.org/&url.base;/
Noticed by:	simon
2008-07-13 14:33:36 +00:00
Remko Lodder
10b33657b5 Fix weird spacing [1] and reword the line before it a bit better.
Spotted by:	danger [1]
2008-07-13 14:30:35 +00:00
Remko Lodder
bccf5d092b Clarify that we need to use the brackets, and update the web page references
with actual links. [1]

Also s/submittal/submission/ (changed by myself)

PR:			123043 [1]
Submitted by:		Lawrence Mayer <lawmay3 at i12 dot com> [1]
2008-07-13 14:04:34 +00:00
Gabor Kovesdan
c5c8eb4b29 - Fix grammar by adding a preposition
PR:		docs/124016
Submitted by:	Sahil Tandon <sahil@tandon.net>
2008-05-28 00:36:07 +00:00
Mark Linimon
6af63593ba Add arm category; add missing reference to amd64 category. 2008-04-23 09:30:01 +00:00
Mark Linimon
8662cebce9 Add text that explains the GNATS categories, starting with the most
important ones and working down.  The mere list was not clear enough.

Glanced over by:	simon
2008-02-03 08:54:34 +00:00
Mark Linimon
fede914c9e Whitespace change for following text changes: translators please ignore. 2008-02-03 07:43:39 +00:00
Mark Linimon
80ad42a8b0 Minor changes to get ready to import some new text: add link to
contributing-ports; correctly use example tags; no longer recommend
the advocacy category; remove some text that will become duplicated.
2008-02-03 07:41:55 +00:00
Marc Fonvieille
d2ed1184e5 SGML fixes: don't use block elements as inline ones, this leads to
a "weird" rendering.
2007-04-14 13:33:44 +00:00
Pav Lucistnik
f5a0529523 Update locations of recently moved ports, like portupgrade, portaudit or
portlint.  I have retained their historical locations in papers which got
written, but are not constantly updated like the rest of our documentation.
2007-02-05 01:33:20 +00:00
Marc Fonvieille
6740f7351a Add a missing closing tag.
PR:		docs/103229
Submitted by:	Hiroo Ono <hiroo@oikumene.gcd.org>
2006-09-13 17:03:53 +00:00
Joel Dahl
f361f5a935 Expand contractions. 2006-02-07 21:32:42 +00:00
Ceri Davies
1d9be2069a s/neccesarily/necessarily/ 2005-10-23 15:27:50 +00:00
Mark Linimon
aac5efa2a6 Claim co-authorship of this, so that the blame for the last several changes
can be assigned to the appropriate mbox.

Approved by:	original author
2005-10-22 08:15:34 +00:00
Mark Linimon
c9a087a388 Major additions of text to this article:
- continue to add more information that is specific to the web-based
   form as opposed to send-pr(1).  In particular, mention problems that
   are particular to that method.

 - greatly expand the text sections about various fields such as
   'categories' to try to adddress continuing misunderstanding on
   the part of our users.

 - discuss the fact that spammers will most likely find your email
   address from a GNATS submission.

 - demote kernel panics to 'serious' to represent commonly accepted
   usage.  Reserve 'critical' for data corruption issues or things that
   would be considered 'showstoppers' for an upcoming release.  (I am
   using my bugmeister hat for this change.)

 - reiterate that serious security problems should go to secteam, not
   into GNATS.

 - document the common problems seen when submitting PRs, including
   our anti-spam measures and the 'lost PR' index problem.

 - deprecate the use of HTML-only messages.  Regression testing using
   the spam filters shows that close to 100% of such messages are spam.
   (The filters have been tuned to correctly pass HTML that is included
   in patches but reject HTML that conforms to all the common abuse
   patterns.  I am using my bugmeister hat for this change).
2005-10-22 07:03:20 +00:00
Mark Linimon
250212cee2 Swap ordering of field descriptions around for some upcoming work.
No text changes.
2005-10-22 04:35:47 +00:00
Mark Linimon
7229e96488 Rewrite all the text about which problems are really FreeBSD problems and
which are problems with code that is merely incorporated into FreeBSD.  In
particular, the original article was written from the standpoint of src/;
these changes put ports/ on an equal basis.  Finally, cross-reference the
src/ versions that secteam supports.
2005-10-20 08:07:08 +00:00
Mark Linimon
b763b48719 Move a block of text in preparation for it being rewritten. Translators
note: this is a copy with no text change (yet).
2005-10-20 07:59:34 +00:00
Mark Linimon
31360fdce5 Add new text about avoiding email mangling; about backing up your work
before you submit; and considerations of when a PR is "too large".
2005-10-20 06:45:47 +00:00
Mark Linimon
06df39fac3 Clarify that send-pr is not the only submission technology. 2005-10-20 06:31:09 +00:00
Mark Linimon
624ab6d711 Move two sentences a little bit later in 'when to submit' and slightly modify
the first one.  This is part of a larger set of changes that are coming.
2005-10-20 06:28:37 +00:00
Remko Lodder
30e46046f2 Make the PR followup address easier to maintain by adding an entity to
the mailing-lists.ent file (though it's not really an mailinglist).
Also replace the current follow up addresses by it's entity name.

Submitted by:		ceri
2005-08-13 21:17:05 +00:00
Jesus R. Camou
b18d432e58 Document what to do if an outdated port
is noticed.

PR:		docs/80681
Submitted by:	Roman Neuhauser <neuhauser@sigpipe.cz>
		Ion-Mihai Tetcu <itetcu@people.tecnik93.com>
Approved by:	trhodes (mentor)
2005-07-19 21:37:15 +00:00
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