Commit Graph

39 Commits

Author SHA1 Message Date
Edward Tomasz Napierala
5167a1a737 Silence down the example builds a bit.
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
2018-11-30 16:02:27 +00:00
Edward Tomasz Napierala
f1d1d6f66e Add an example of quick kernel rebuild.
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
2018-11-30 16:01:43 +00:00
Edward Tomasz Napierala
873a1193b7 Add an example of rebuilding a single piece of userspace.
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
2018-11-30 15:56:14 +00:00
Mateusz Piotrowski
03840eefd7 development(7): Replace "reboot" with "shutdown -r now"
We generally document shutdown(8) instead of reboot(8) as it's better for
interactive use.

In modern FreeBSD is matters a lot less, it's mostly just convention. One
minor thing is that shutdown(8) produces a global message, while reboot(8)
does not. It is believed that historically, some versions of reboot did not
do appropriate safe shutdown checks and just rebooted.

It's also just consistency: for example the handbook[1] documents shutdown.

There is actually another important difference between reboot and shutdown
-r now: reboot does not run /etc/rc.shutdown. This is because reboot has
its own shutdown procedure and does not signal init like init 6 and
shutdown -r now do (except in the case of rerooting via reboot -r).

A few years ago jilles@ proposed changing reboot's default to signalling
init (preserving reboot -q which just invokes the reboot system call), but
this was not accepted. Perhaps this can be tried again for 13.0.

[1]: https://www.freebsd.org/doc/handbook/boot-shutdown.html

Reported by:	eadler
Reviewed by:	eadler, jilles
Approved by:	krion (mentor)
Differential Revision:	https://reviews.freebsd.org/D16843
2018-11-16 14:29:28 +00:00
Mateusz Piotrowski
2bd42f2f4d Suggest to reboot after installworld in the example of development workflow.
Reviewed by:	trasz
Approved by:	mat (mentor)
Differential Revision:	https://reviews.freebsd.org/D16746
2018-08-22 13:25:41 +00:00
Edward Tomasz Napierala
b920f69bd0 "Kernel APIs" is a misnomer; use the proper name instead.
Suggested by:	kib@, ian@
MFC after:	2 weeks
2018-06-21 08:19:11 +00:00
Edward Tomasz Napierala
4c156ba299 Improve wording.
MFC after:	2 weeks
2018-06-20 19:16:51 +00:00
Edward Tomasz Napierala
5596cb9463 Improve development(7):
- Use Fx when referring to FreeBSD.
 - Use Ql instead of Cm for command invocations.
 - Remove some redundant Pp macros.
 - Use a literal indented Bd instead of a series of Dl macros.

Submitted by:	0mp@
Reviewed by:	eadler@
MFC after:	2 weeks
Differential Revision:	https://reviews.freebsd.org/D15126
2018-05-11 15:11:53 +00:00
Edward Tomasz Napierala
9c08ba7704 Make development(7) mention tests and section 9 of manual pages.
MFC after:	2 weeks
2018-04-10 08:01:55 +00:00
Edward Tomasz Napierala
ac663598df Add trailing slash for consistency.
For some reason, the other link - https://lists.FreeBSD.org/ - needs
the trailing slash, otherwise man(8) renders it in a weird way.  No
idea why's that.  At least try to be consistent.  Revert it when the
other link gets fixed.

MFC after:	2 weeks
2018-03-27 14:54:02 +00:00
Edward Tomasz Napierala
f9b7620b3e Use https:// instead of http://.
MFC after:	2 weeks
2018-03-27 14:51:19 +00:00
Edward Tomasz Napierala
f007c46d25 Fix capitalization.
MFC after:	2 weeks
2018-03-27 14:50:12 +00:00
Edward Tomasz Napierala
d09cfd2724 Fix typo.
MFC after:	2 weeks
2018-03-18 16:24:11 +00:00
Edward Tomasz Napierala
bdfc6e62ff Here's the new development(7), which removes information that's
no longer relevant (read: most of what was there) and adds some
quick links to point newcomers in the right direction.

Reviewed by:	imp@
MFC after:	2 weeks
Differential Revision:	https://reviews.freebsd.org/D14680
2018-03-18 15:44:07 +00:00
Baptiste Daroussin
a63d6c943d use .Mt to mark up email addresses consistently (part6)
PR:		191174
Submitted by:	Franco Fichtner <franco at lastsummer.de>
2014-06-23 08:27:27 +00:00
Sergey Kandaurov
11f7d10cc7 Clean up paragraph remnants. 2013-12-04 20:46:25 +00:00
Gavin Atkinson
57150983c6 Suggest using the https: protocol not the svn: protocol to retrieve the
various repositories.
2013-03-07 13:24:16 +00:00
Eitan Adler
7cc324f8bd Remove some duplicated advice.
While here increase the suggested sizes for the
partition as "make universe" takes a lot more
space than mentioned.

Reviewed by:	gavin
Approved by:	gjb
MFC after:	3 days
X-MFC-With:	r240728
2012-09-22 21:34:46 +00:00
Joel Dahl
d62a0fbf2a mdoc: remove superfluous paragraph macro. 2012-09-20 04:53:12 +00:00
Eitan Adler
1fce71e497 Rewrite portions of development.7 to make sense
in the world of subversion.

Approved by:	gjb
MFC after:	2 weeks
2012-09-20 03:48:36 +00:00
Eitan Adler
3e0efd2ec4 Fix style nit: don't use leading zero for dates in .Dd
Prompted by:	brueffer
Approved by:	brueffer
MFC after:	3 days
2012-06-05 03:14:39 +00:00
Eitan Adler
9d64a0ce19 Prefer the use of csup to cvsup when talking about the binary.
PR:		docs/167459
Submitted by:	"Bryan Drewery" <bryan@shatow.net>
Approved by:	bcr
MFC after:	1 week
2012-05-02 21:50:13 +00:00
Mike Pritchard
b66cd36df6 Don't use abbreviations for some descriptions / minor spelling fixes. 2006-12-14 13:35:59 +00:00
Yaroslav Tykhiy
08b9134350 Replace "/etc/make.conf" with references to make.conf(5)
where applicable.  The main reason for this change is that
the location of make.conf is not constant and can be
modified via __MAKE_CONF.  This change also improves
hyper-text linkage in our manpages.

MFC after:	2 weeks
2005-10-10 14:55:59 +00:00
Christian Brueffer
f0ea72a038 - Remove MLINKS to nonexistant manpages
- Change some section numbers to match reality
- For MLINKS to manpages from ports, mention which port installs them

MFC after:	3 days
2005-07-14 20:29:08 +00:00
Ruslan Ermilov
c201414f0a Overhaul the markup. 2005-01-15 11:12:40 +00:00
Warner Losh
5ecb12e35b Expand indirect reference to copyright file to the portion of that file
that is relevant.
2004-08-07 04:40:20 +00:00
Hiten Pandya
d2069767f5 Remove an unnecessary comma from the Copyright.
Obtained from:  DragonFly BSD
2004-07-25 16:10:03 +00:00
Ruslan Ermilov
5203edcdc5 Mechanically kill hard sentence breaks and double whitespaces. 2004-07-03 18:29:24 +00:00
Ruslan Ermilov
d37ea99837 Removed trailing whitespace. 2004-07-02 19:07:33 +00:00
Nate Lawson
61a63db063 Add a warning describing at least one circumstance where cvsup can hose
a local branch.  Text from an email from jdp@

Reported by:	simon
2003-08-25 19:08:37 +00:00
Nate Lawson
b842ac21d6 Add a section on maintaining a local branch in CVS.
MFC after:	1 day
2003-08-22 17:12:55 +00:00
Ruslan Ermilov
149c72305b Kill whitespace at EOL.
Approved by:	re (blanket)
2003-05-21 15:55:40 +00:00
Christian Brueffer
8347fe67c9 Add a reference to release(7)
Requested by:	murray
Approved by:	re (murray)
2003-05-21 07:16:32 +00:00
Christian Brueffer
c89927b8cb Sort references by section
PR:		52501
Submitted by:	Simon L.Nielsen <simon@nitro.dk>
Approved by:	re (scottl)
MFC after:	3 days
2003-05-20 23:25:44 +00:00
Matthew Dillon
06d66a71a1 Some Pa fixes from Tom, plus a little rearranging of the paragraph by me.
Submitted by:	Tom Rhodes
2002-12-28 19:08:11 +00:00
Matthew Dillon
48096bb398 A pile of patches, most notably some Doc policing by Hiten Pandya. 2002-12-23 07:27:53 +00:00
Jens Schweikhardt
1ef979ba18 english(4) police. 2002-12-22 21:04:59 +00:00
Matthew Dillon
6ed033be24 So many people have asked me to describe my development environment that
my fingers are getting tired.  Here is a new manual page, 'development',
which describes a very powerful, generic, exportable development environment
suitable to developers, sysops, admins, and anyone at all who is
maintaining more the one FreeBSD box.  I have used this type of environment
for many years and have had to make virtually no changes to it for all that
time.

MFC after:	3 days
2002-12-22 02:07:05 +00:00