os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
11878 commits 1 branch 79 tags 298 MiB
Commit graph

193 commits

Author SHA1 Message Date
Peter Wemm
b9a19509fb After much agonizing, attempt to refine the commit log composition 
instructions.  The potentially conflicting instructions could be taken
to encourage less than ideal commit logs.  Explicitly say that we're
after a clear, concise and reasonable summary of the change.

Reviewed by:	obrien
 2001-11-28 21:25:56 +00:00
Chern Lee
fac4584d62 Reverse four instances in previous spelling-fix commit: 
* out takes -> outtakes
 * blinking lights -> Blinkenlights
 * hard coding -> hardcoding
 * place holder -> place holder

Pointed out by: des
 2001-11-05 19:13:01 +00:00
Chern Lee
98698f4f5e Spell check in articles: 
* outtakes -> out takes
 * themself -> themselves
 * manpages -> man pages
 * suprising -> surprising
 * Blinkenlights -> blinking lights
 * transmition -> transmission
 * coresponds -> corresponds
 * accessable -> accessible
 * disasserting -> dis-asserting (for lack of a better word)
 * harddisks -> hard disks
 * likelyhood -> likelihood
 * repeate -> repeat
 2001-10-31 23:10:31 +00:00
Murray Stokely
a4cf0e1eba Fix broken links. 
PR:		docs/31447
Submitted by:	Cyrille Lefevre <clefevre@citeweb.net>
 2001-10-23 21:19:23 +00:00
Mike Barcroft
84255d06ed Add guidelines for deprecating features. 
Partially submitted by:	sheldonh
Approved by:		-developers
 2001-10-23 17:11:14 +00:00
Giorgos Keramidas
0b824da1aa Remove all contractions from most of the articles. This solves the 
problems with the usage of "its" vs "it's" among other things

Approved by:	nik
 2001-10-16 11:53:01 +00:00
Giorgos Keramidas
fb07ee81fc Replace quote characters with SGML <quote>. 
Also add an <xref> to a section instead of quoting it's title.

Approved by:	nik
 2001-10-15 13:26:02 +00:00
Mike Barcroft
5c3cd78ad4 Correct the Committer Guide: 
newsflash.sgml is now news.xml

Discussed with:	nik
 2001-08-22 23:16:09 +00:00
Murray Stokely
65edfaeafc Update links to the Handbook Contributors chapter and Staff appendix 
to point to the new Contributors List article instead.
 2001-08-06 22:43:27 +00:00
Nik Clayton
563344e601 Add an entry for myself in to "Who's Who". 
This originally wasn't going to be quite so self-serving a commit.  But I
see that Dima has already committed the other patches to this file while
I wasn't paying attention. . .
 2001-07-16 15:33:07 +00:00
Dima Dorfman
62e08c0139 Use &os.current; and &os.stable; where appropriate. 
Submitted by:	Mike Barcroft <mike@q9media.com>
 2001-07-15 06:33:28 +00:00
Dima Dorfman
f5838bd6ef Document 'MFC after:'. 
Submitted by:	Mike Barcroft <mike@q9media.com>
 2001-07-15 05:22:50 +00:00
David E. O'Brien
0caaf5d84f When PHK committed rev 1.50, he did not adjust the references to particular 
rule numbers to take into account the new numbering.
 2001-07-14 03:38:03 +00:00
Nik Clayton
5a8491908e Switch to using version 4.1 of the DTD. 2001-07-13 15:36:28 +00:00
Nik Clayton
3ed1f7ea58 Favour <command> over <literal> when talking about CVS subcommands. 
PR:		docs/28731
Submitted by:	Giorgos Keramidas <keramida@ceid.upatras.gr>
 2001-07-11 14:08:50 +00:00
Nik Clayton
ee0aacd375 Add more details about the "cvs log" command. 
PR:		docs/28730
Submitted by:	Giorgos Keramidas <keramida@ceid.upatras.gr>
 2001-07-11 13:22:17 +00:00
Dima Dorfman
73e2ee8aa9 Assorted spelling, punctuation, and markup fixes. 
PR:		28732
Submitted by:	Giorgos Keramidas <keramida@ceid.upatras.gr>
 2001-07-08 01:17:53 +00:00
Nik Clayton
1c985b66c3 Mention calendar.freebsd as something a new committer might want to 
contribute to.
 2001-06-22 08:18:55 +00:00
Andrey A. Chernov
f749b200c1 ISO_* -> ISO* rename 2001-06-11 01:20:40 +00:00
Nik Clayton
ad13c1c330 Link to Karl Fogel's chapters on how to use CVS. 
Submitted by:	joe
 2001-06-09 14:01:06 +00:00
Dima Dorfman
006caeb4c3 DocBook police: use man page entities where appropriate. 2001-06-03 21:39:52 +00:00
Dima Dorfman
b8a47158e4 Explain that src/contrib, src/crypto, and src/sys/contrib are off 
limits without explicit maintainer approval.

Asked about but thread drifted off into other matters on: developers@
 2001-06-02 05:45:59 +00:00
Gregory Sutter
357f80a5ed Correct punctuation and grammar. 
Reviewed by:	dd, chris
 2001-05-29 19:29:25 +00:00
Nik Clayton
6895e948d5 Alphabetize the "Who's Who" list. 2001-05-13 15:44:20 +00:00
David E. O'Brien
9906e5666d Fix a mismatched '('. 
Submitted by:	eric
 2001-05-12 08:07:35 +00:00
David E. O'Brien
a0dc93d3a5 Replace Obersturmbahnfuhrer with "Meister" -- someone who has earned an 
official degree in craftmanship (which is required to allow teaching the
profession to others).  There are overtones with "Obersturmbahnfuhrer"
that we should avoid.

Requested by:	Jens Schweikhardt <schweikh@schweikhardt.net>
 2001-05-12 02:07:27 +00:00
Bruce A. Mah
332440afa1 Reflect that the release notes could live in one of two directories. 2001-05-11 04:38:52 +00:00
Jens Schweikhardt
e987a4430a Fixed typos and grammar bogons. 2001-05-07 15:46:10 +00:00
Nik Clayton
f384f4e578 "Bruce" in the previous commit is Bruce Evans, bde, and not any of the other 
Bruces we have floating around the project.

G'day Bruce.
 2001-04-27 10:08:44 +00:00
Nik Clayton
bb50fb63d7 Completely rewrite question 10.1 ("Why are cosmetic changes on the vendor 
branch a bad idea?") with more correct information provided by Bruce.
 2001-04-27 10:07:52 +00:00
Nik Clayton
f68cc9b180 Adjust JADEFLAGS, to generate a table of contents for this article. 2001-04-08 17:26:59 +00:00
Nik Clayton
3701fb2419 Clarify the text for a commit from a PR, making it clear that the explanatory 
text should not be part of the log.
 2001-04-08 17:26:41 +00:00
David E. O'Brien
d135bff76f Back out rev 1.57. It wasn't clear to me what was being said in rev 1.56. 
Hopefully the header "Commit log" will bet tweaked to not give the
impression the example is supose to be a complete log message and thus
the text is an example of a good commit message.
 2001-04-07 18:22:32 +00:00
David E. O'Brien
9c0b49da1f Steve Price isn't the [unoffical] maintainer of `src/bin'. 
Steve says: "That's just plain wrong."
 2001-04-05 20:35:49 +00:00
David E. O'Brien
eff1349e39 Change the example commit message of rev 1.56 to one that has content vs. 
stating the obvious in-order to give a better example of what a minimal
commit message should be.
 2001-04-05 20:34:32 +00:00
Nik Clayton
72210abed1 Document our oral tradition in re what meta information to include at the 
bottom of a commit message, and the format that information should take.
 2001-04-04 11:54:01 +00:00
Nik Clayton
f9e2cffeab Remove the frames from some of the tables. Make some of the 
<informaltable>s real <table>s, with a title (instead of putting the
notional title in a <para> immediately before it.

Add Bruce Mah to the Who's Who section for the Release Notes.

Add Ruslan Ermilov to the Who's Who section as Mr mdoc(7).
 2001-04-04 08:31:49 +00:00
Jun Kuriyama
72d0d0a0e3 Fix breakage in previous commit. 
Usage of <term> in <varlistentry> must be <term>+ (no characters allowed
between each <term>).
 2001-04-04 00:52:50 +00:00
David E. O'Brien
570b771e8e Add the Alpha points of contact. 
Add myself as src/contrib consultant.
Note Bruce and Garrett as ones to consult RE standards issues.
 2001-04-03 16:12:05 +00:00
David E. O'Brien
6df2bb3d4e Fix spelling errors. 2001-04-03 16:04:54 +00:00
Ben Smithurst
905911ab27 Try not to give the impression 'cvs import' should be used for ports. 
Reviewed by:	jhb
 2001-03-28 23:43:47 +00:00
Poul-Henning Kamp
86b72726db Add a new rule to the committers: respect other contributors as well. 
There has been plenty of discussion about how to actually ratify
such rules, but nobody has opposed this specific rule (which is a
good show of maturity btw).

In the end the conclusion is that this is not really any different from
the rest of the tree: If it makes sense: commit it, if it creats an
uproar, back it out and paint the bikeshed.

QED.

PR:		25783
Submitted by:	Dan Langille <dan@langille.org>
Reviewed by:	developers
 2001-03-28 10:55:43 +00:00
Brian Somers
69fb29a67b /usr/bin/ppp -> /usr/sbin/ppp. 
Also, I think I modified lpd once about two years ago.  Relinquish the
apparent title of ``maintainer''.
 2001-01-25 00:09:15 +00:00
Trevor Johnson
05e23a69fd Mention the pgpkeys file. 
Looked at by:	will

Update copyright.
 2001-01-15 03:49:03 +00:00
Daniel Harris
f5d071f028 environmenet -> environment 
PR:		24234
Submitted by:	Jimmy Olgeni <olgeni@uli.it>
 2001-01-13 02:04:07 +00:00
Chris D. Faulhaber
c04b5861e1 Update link for CVS reference information 2000-12-28 13:40:03 +00:00
Jim Mock
78991380db Add the cvs-committers and developers mailing lists to the Who's Who 
section of the committer's guide.  While I'm here, change some
instances of freebsd.org to FreeBSD.org.

Submitted by:	obrien
 2000-12-05 21:39:14 +00:00
Dmitry Sivachenko
8787cae6a4 Fix typo. 
Approved by:	sobomax
 2000-11-14 11:11:56 +00:00
Maxim Sobolev
b0f39ddd51 Add a note that leaving `cvs ci' in message editing mode for long period of time 
is no-no.

Reviewed by:	jhb
 2000-11-03 19:01:27 +00:00
David E. O'Brien
c6c4270992 Capitalize "Alpha". 2000-10-09 17:09:14 +00:00
David E. O'Brien
bad7c214a0 We do not have a Principal Architect any longer. 2000-10-09 17:08:39 +00:00
Alexander Langer
5d6b8a0d89 Back out the bento -> onigiri change, it was wrong. 
Submitted by:	obrien
 2000-10-02 08:31:25 +00:00
David E. O'Brien
dd7cbed941 Document developers@freebsd.org 2000-10-02 04:23:21 +00:00
Alexander Langer
d1affdab96 Minor changes: 
* bento -> origini
* reflect 4-stable & 5-current.

Submitted by:	James Housley <jim@thehousleys.net>
 2000-09-30 14:25:53 +00:00
Kris Kennaway
b256c3a748 Overhaul the documentation relating to crypto and related topics. Some of 
this stuff had been out of date for 3 or 4 years or more.

Reviewed by:	alex
 2000-09-24 07:01:53 +00:00
Ben Smithurst
fda7bf8bf8 Specify that committers should use a umask of 2 on freefall, so that 
files/directories added to the repository get the correct group-writable
permission.
 2000-08-23 20:36:53 +00:00
Daniel Harris
1d3c1680b6 Add a missing space ("the add _ command"). 
New committers should add themselves to the "Developers" section, not the
"Developer's" section.
 2000-08-16 17:41:40 +00:00
Jun Kuriyama
61306ad2cc Add &man.vim.1; entry. 
Fix bugs in using <screen> element.
Use $FreeBSD$ instead of $Date$.
 2000-08-15 01:39:52 +00:00
Josef Karthauser
407df909f1 Add a note that you can use the vim editor as a useful tool for viewing 
diffs, logs, etc, with syntax highlighting switched on.
 2000-08-13 14:07:12 +00:00
Ben Smithurst
023e3aa0ef Mention 'addport' instead of 'easy-import' as the method for adding new 
ports.

Approved by:	jhb
 2000-08-05 21:05:39 +00:00
Ben Smithurst
17d5973aca Mention that SSH is in the base system from 4.0 onwards. 
Approved by:	jhb
 2000-07-29 00:47:52 +00:00
Ben Smithurst
ff5aaba5d8 Fix some stupid mistakes I made when adding des' CVS primer: 
* $FreeBSD$ shouldn't be expanded when used in the explanation of
   conflicts.
 * Add some markup bits I missed, fix typoes, fix broken hyphenation
   caused by joining lines together which had hyphenated words split over
   them.
 2000-07-26 17:53:17 +00:00
Ben Smithurst
027be86094 Add mini CVS primer. 
Text submitted by:	des
Approved by:		jhb
 2000-07-26 01:17:18 +00:00
Mark Ovens
7a947097f5 Add note about the use of tags when cvsup'ing the GNATS tree. 2000-07-24 20:02:45 +00:00
Nik Clayton
a26dd557eb Rewrite the abstract. This isn't just a CVS document any more. 
Shift the information about the repository-meisters in to the first
section about CVS.

Re-write the list of things that a new committer should do as a numbered
list.  Mention the existence of the xearth committers' markers file.
 2000-07-23 16:22:16 +00:00
Mark Ovens
22b4847fcb Changed out of date section reference in Conventions & Traditions 2000-07-13 21:07:52 +00:00
Kevin Lo
73c016c2cd Correct the link for porters handbook 2000-07-10 15:01:52 +00:00
Daniel Harris
6312bd2fb1 Corrected links to CVS info at cyclic.com, various grammar and typo fixes. 
Also reworded in a couple places for clarity's sake.
 2000-07-08 15:32:00 +00:00
Nik Clayton
d3d532c64f * RCS Date string in <date> 
* Add year to <copyright>

 * Explain how you can use CVSup to download the PR database, and then
   teach a local copy of GNATS about the files you've installed, to make
   it easier to query them without being online all the time.

   Prompted by Warner's query on -committers last month.  Doing this is
   actually fairly trivial, but I figure a lot of you'll benefit from it.

 * Change some &prompt.user; to &prompt.root; (as far as I can see, you
   need to run the commands as root).

 * Update a link to point to the Porter's Handbook.
 2000-06-08 18:12:54 +00:00
John Baldwin
dff69dd1ee - Update the copyright to include 2000 
- Fix capitalization of the title of the last section
- Add a new FAQ to the Misc. Questions section that explains how to add a
  file to a CVS branch, complete with a real-life example.
 2000-05-24 21:40:56 +00:00
Bill Fumerola
7ba3bbea62 asami-san controls ports freezes, not code freezes. 2000-05-19 19:08:00 +00:00
Nik Clayton
9e3b2b0844 Drop a few instances of the word "new" from this, as it's something all 
committers should re-read every now and then, and not just when they get
handed the hat.

Prompted by:	asami
 2000-04-07 09:52:20 +00:00
Nik Clayton
bcd4ff78fc Tell the new committer to add themselves to www/en/news/newsflash.sgml 2000-04-03 23:12:27 +00:00
Jordan K. Hubbard
77b3e4f98d Add mention of RELENG_4 tag 2000-03-26 20:33:34 +00:00
John Baldwin
de56fa420c Whitespace cleanups. Translators can ignore. 2000-02-03 02:38:10 +00:00
John Baldwin
e49d537086 Patch to the committers guide including several grammar fixes, markup 
fixes, and re-wordings to try and make the text clearer. I also expanded
several contractions, mentioned Bill Fenner's whodid script, and added a
couple of clarifications.

Reviewed by:	obrien, nbm
Reviewed by:	Will Andrews <andrews@technologist.com>
 2000-01-27 15:31:37 +00:00
John Baldwin
20193a67fe Add a new paragraph to the suggestions section stating that 
style/whitespace changes should not be mixed with functionality/content
changes but should be done in separate commits.

Requested by:	obrien
 2000-01-22 04:15:21 +00:00
Nik Clayton
a8ab59b6bc Add a new "miscellaneous questions" section. The first question is "Why 
are changes to files on the vendor branch a bad idea?", and the answer is
supplied by an (almost) verbatim excerpt from one of Peter Wemm's messages
to committers (<19991129055252.65D5E1C6D@overcee.netplex.com.au>).
 2000-01-19 22:37:18 +00:00
John Baldwin
1fcca0967c Update the section on SSH to include a blurb on OpenSSH. Also update some 
other references to ssh to make them reflect reality a little better.

Submitted by:	green
 1999-12-08 05:31:55 +00:00
Alexey Zelkin
74307f88b3 "Don't forget to remove yourself from the Additional Contributors 
section " (c)

Reviewed by:	maintainer
 1999-10-30 13:05:59 +00:00
Alexey Zelkin
c7e21561e5 A HREF="mailto:maillist" -> A HREF="mailto:maillist@FreeBSD.org" 
"phraze" -> <qoute>phraze</quote>

Reviewed by:	maintainer
 1999-10-15 12:46:41 +00:00
John Baldwin
a54d72c628 Merge the ports committers' guide into the new committers' guide. 
Reviewed by:	nik
 1999-09-29 02:12:37 +00:00
Bill Fumerola
1ff360dbbe Remove a few lines that made this still read like a letter rather 
then a guide.

Reviewed by:	jhb
 1999-09-23 04:42:47 +00:00
John Baldwin
fc9d0ed5e4 - Spelling fix: 'cypto' -> 'crypto' 
- A few 'freebsd' -> 'FreeBSD' fixes
 1999-09-23 01:45:29 +00:00
John Baldwin
afbb1dbec4 Slightly reword a sentence. Also, the 'Big List of Rules' belongs to 
all committers, not just one unnamed one.

Reviewed by:	jim
 1999-09-16 02:48:02 +00:00
Nik Clayton
19d4d8cc1a Add the big list of rules that was thrashed out on -committers recently. 
Final text was from JKH, I ran it through the txt2docbook filter.
 1999-09-15 19:14:48 +00:00
John Baldwin
a803a09790 Minor whitespace cleanup. 1999-09-09 13:16:59 +00:00
Mark Murray
2fb650b74f Update the bit about using SSH/Kerberos5 to connect to the FreeBSD 
servers. Also update the bit about crypto code and my role with it.
 1999-09-08 18:17:39 +00:00
Peter Wemm
5ff728b8ca $Id$ -> $FreeBSD$ 1999-09-06 06:53:43 +00:00
Nik Clayton
80a4decd05 Used ${.CURDIR}, for "make obj" friendliness. Should have added 
this before the initial commit, d'oh!

PR:             docs/13571
Submitted by:   Neil Blakey-Milner <nbm@rucus.ru.ac.za>
 1999-09-05 22:14:26 +00:00
John Baldwin
cbc5c27ed4 Extend the Ports Wraith's description to include being a repo meister 
for ports/.

Requested by:	asami
 1999-09-04 00:02:37 +00:00
John Baldwin
2e5188748f Add descriptions of the International Crypto Repo at internat.FreeBSD.org 
and suitable mentions of its maintainer, markm.

Requested by:	markm
 1999-09-03 23:58:13 +00:00
Nik Clayton
5f291ead9b The FreeBSD New Committer's Guide. The original text version was worked 
on by many people, the SGML conversion has been carried out by the new(ish)
committer, John Baldwin.  Cheer's John.

Changes from the submission:

  1.  It's an article, not a book.  I originally thought there was going
      to be sufficient content (when you include the committers rules
      that are being thrashed out at the moment, and Satoshi's ports
      committer stuff) to make this worth being a book.  After seeing the
      content I changed my mind, so it's an article.

  2.  Various contractions ("you're" and so on) expanded to make life
      a little easier for the translators.  Kept one ("Who's Who").
 1999-09-03 17:10:42 +00:00