informaltable element properly, unless the pgwide attribute is
explicitly set to 1. Use this consistently within the (en) tree, and
update the FDP accordingly. This should finally silence the demons in:
PR: docs/73095
Submitted by: Hilko Meyer <Hilko dot Meyer at gmx dot de>
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.
is not defined.
- URL_RELPREFIX must always point the top page's URL
(http://www.FreeBSD.org) in relative form, defined in Makefile.
- &url.base; can be used in doc/<langcode>/*. It will be
replaced with the real URL which points the top page.
For translators: Please make sure to define URL_RELPREFIX to
point the top page. The localized docs have different directory
hierarchy in its URL from the English version.
Tested by: den
changes was done to the original after the repo-copy, so merge in
those changes (v. 1.21-1.28). Since this file has also been changed
since the repo-copy the changes was merge in by hand, so it is not a
straight merge of the changes.
Note: This chapter seems seriously out-of-date.
Ihis entity auto-replaced with ../../../.. by default
and with http://www.FreeBSD.org/ when URLS_ABSOLUTE is set
(used for mirrors and for release building accordingly)
- Use trademark entities.
- Add trademark attributions.
- Don't join trademarks with other words, e.g. using hyphens.
trademark.ent:
- Add trademark entity for Sun.
At the moment the main content is the Micro Benchmark Checklist posted
to -current by phk and expanded by rwatson. The list did not really fit
in any of the current chapters, so a new chapter was created. I hope
others can add more content to this chapter later.
Content by: phk, rwatson
Reviewed by: phk, josef
No objections: -doc
dump and the basics of what most developers would like to see in reports
of a panic where a dump is available. Also trim a few lines from the
previous dump example (still included) and sync up some of the gdb
commands for the sake of consistency.
Inspired by: Recent exchange with jhb
instructions inline with reality (ex: savecore hasn't had the -N flag for
a while). The verbage here should be sufficient for developers to be able
to point users on current@ to these first two sections and have them
extract something reasonably useful, esp now that -CURRENT no longer means
FreeBSD 3.1.
various examples so that this chapter is useful to new and unsuspecting
vict^H^H^H^Huser^H^H^H^Hkernel debuggers.
Submitted by: echo "(setq-default show-trailing-whitespace t)" >> ~/.emacs
- FreeBSD Architecture Handbook, which is a book about the FreeBSD
architecture. The SMP article have also been moved into the new
arch handbook as a separate chapter.
- FreeBSD Developers Handbook, which is a book about developing on
FreeBSD; basically what was left when the architecture parts was
moved away.
o Hook up the new FreeBSD Architecture Handbook to the build.
o Remove the SMP article since it is now part of the FreeBSD
Architecture Handbook.
The relevant files from the FreeBSD Developers Handbook have been
repository copied to the new FreeBSD Architecture Handbook.
This is just step one in the split, both books need some work to be
real seperate books. E.g. the FreeBSD Architecture Handbook still
needs an introduction.
Repository copy by: joe
Requested by: rwatson
Approved by: murray, ceri (mentor)
new device entry for PC Card devices with NEWCARD.
I've not connected this to the build because I can't test it locally
on this machine. Feel free to fix any problems in this file, so long
as you don't change the semantic meaning without asking me. I write
code, not docs :-)
Thanks to the person who attended my devd talk in INTEROP+NETWORLD
2003 Tokyo BSD BOF via IRC who asked me how to do this in the Q&A
section. An excellent question that I glossed over at the BOF, but
hopefully this rectifies the problem.
Eventually, I'd like to expand this to include more information about
how to write a driver for a PC Card or CardBus device, but for now
this will have to do.
1) Use the new c99 initialization in the pci driver example. Also,
don't claim this device is a tty.
2) Add notes about caution needed during detach routine wrt interrupts
and locking.
3) Add note that vtophys is deprecated and to use busdma instead.
Since the busdma API isn't completely settled for 5.x yet,
don't document it. I'll leave that to others when the API is
done being frobbed.
- Add Management Interfaces (sysctls, tunables, et al).
- Add Concurrency and Synchronization (busy count handling to synchronize
policy loading).
- Add Policy Registration (management of active poliy lists).
- Flesh out Labeling Support to talk about label initialization and
life cycles, allocation semantics.
- Add System Calls.
Obtained from: TrustedBSD Project
Sponsored by: DARPA, Network Associates Laboratories
- Move Userland Architecture down to the Userland APIs section.
- Push most of the Policy-related subsections into the MAC Policy
Architecture section. Tweak a little language so it makes
sense.
Note that the MAC Framework can also be used to express DAC policies.
Push the MAC Framework Policy Elements section up a level to sect1 and
name it "MAC Policy Architecture".
Stick "MAC" in front of the Policy Entry Points section header to
improve consistency.
Developer's Handbook: break out the "Entry Point Framework" section
into a number of sections: MAC Policy Declaration, Entry Point
Introduction, MAC Policy Entry Point Reference. Re-order sections
a bit so there's a more logical progression and fewer large chunks
of text over many pages. This greatly improves readability.
Obtained from: TrustedBSD Project
Sponsored by: DARPA, Network Associates Laboratories
