Skip site navigation (1)Skip section navigation (2)
Date:      Fri, 16 Oct 2015 23:13:26 -0700
From:      Russell Haley <russ.haley@gmail.com>
To:        freebsd-arm <freebsd-arm@freebsd.org>, freebsd-doc@freebsd.org,  Ian Lepore <ian@freebsd.org>, John-Mark Gurney <jmg@funkthat.com>, Warner Losh <wlosh@bsdimp.com>
Subject:   Fwd: Patch file for man pages netmap.4, src.conf.5, build.7
Message-ID:  <CABx9NuQxmSJkceXa_5EdT3o8EaeYXU4G6B==UQVxi%2BPHhkQGtw@mail.gmail.com>
In-Reply-To: <CABx9NuSvSvy03j1_=7w28TPFiru6p_58Mv9ekJHnjTfLhRaGQQ@mail.gmail.com>
References:  <CABx9NuSvSvy03j1_=7w28TPFiru6p_58Mv9ekJHnjTfLhRaGQQ@mail.gmail.com>

next in thread | previous in thread | raw e-mail | index | archive | help
--001a11438a8e6fcea2052246cf79
Content-Type: text/plain; charset=UTF-8

Ha ha, now WITH attachment...

Russell
---------- Forwarded message ----------
From: Russell Haley <russ.haley@gmail.com>
Date: Fri, Oct 16, 2015 at 11:11 PM
Subject: Patch file for man pages netmap.4, src.conf.5, build.7
To: freebsd-arm <freebsd-arm@freebsd.org>, freebsd-doc@freebsd.org
Cc: Warner Losh <imp@bsdimp.com>, Ian Lepore <ian@freebsd.org>, John-Mark
Gurney <jmg@funkthat.com>


Hi,

There was a previous discussion about making some small changes to the
src.conf and build man pages to include reference to src.conf.5 in the
buikd.7 manpage. I have updated the two documents appropriately. I believe
I also addressed Mr. Loshs' comment pertaining to the scope of the src.conf
file and the format of the title. I also found a typo in netmap.4.

In terms of coming up to speed with documentation, I had asked about where
to find documentation about, er, documentation and started with the
Documentation Primer (Why is this a "primer" and others are a "handbook"?).
This seems to me to be a mistake. After claiming domain over man pages, the
"primer" never mentions mdoc, groff, troff, man, mandoc or any other item
that seems remotely related to man pages ever again? Please, correct me if
I am wrong.

I did however find the following bits of information:


https://forums.freebsd.org/threads/howto-create-a-manpage-from-scratch.13200/

https://www.freebsd.org/cgi/man.cgi?query=mdoc&apropos=0&sektion=0&manpath=FreeBSD+10.2-RELEASE&arch=default&format=html

http://mdocml.bsd.lv/
http://mdocml.bsd.lv/man/mdoc.7.html

http://manpages.bsd.lv/

Which could be pieced nicely together to make a man pages handbook or at
least a section in the "primer"?

Thanks,

Russell

--001a11438a8e6fcea2052246cf79
Content-Type: text/plain; charset=US-ASCII; name="netmap.4-src.conf.5-build.7.diff"
Content-Disposition: attachment; filename="netmap.4-src.conf.5-build.7.diff"
Content-Transfer-Encoding: base64
X-Attachment-Id: f_ifuouanq0

SW5kZXg6IG1hbjQvbmV0bWFwLjQKPT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09
PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PQotLS0gbWFuNC9uZXRtYXAuNAkocmV2aXNp
b24gMjg5NDExKQorKysgbWFuNC9uZXRtYXAuNAkod29ya2luZyBjb3B5KQpAQCAtMzg1LDcgKzM4
NSw3IEBACiAgICAgIFRYICBbLi4uLi4uLi4uLmFhYWFhYWFhYWFhLi4uLi4uLi5dCiAuRWQKIC5Q
cAotc2VsZWN0KCkgYW5kIHBvbGwoKSB3bGxsIGJsb2NrIGlmIHRoZXJlIGlzIG5vIHNwYWNlIGlu
IHRoZSByaW5nLCBpLmUuCitzZWxlY3QoKSBhbmQgcG9sbCgpIHdpbGwgYmxvY2sgaWYgdGhlcmUg
aXMgbm8gc3BhY2UgaW4gdGhlIHJpbmcsIGkuZS4KIC5EbCByaW5nLT5jdXIgPT0gcmluZy0+dGFp
bAogYW5kIHJldHVybiB3aGVuIG5ldyBzbG90cyBoYXZlIGJlY29tZSBhdmFpbGFibGUuCiAuUHAK
SW5kZXg6IG1hbjUvc3JjLmNvbmYuNQo9PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09
PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09Ci0tLSBtYW41L3NyYy5jb25mLjUJKHJl
dmlzaW9uIDI4OTQxMSkKKysrIG1hbjUvc3JjLmNvbmYuNQkod29ya2luZyBjb3B5KQpAQCAtMiw3
ICsyLDcgQEAKIC5cIiBmcm9tIEZyZWVCU0Q6IGhlYWQvdG9vbHMvYnVpbGQvb3B0aW9ucy9tYWtl
bWFuIDI4Nzk0MiAyMDE1LTA5LTE3IDIyOjA0OjQ2WiBiZHJld2VyeQogLlwiICRGcmVlQlNEJAog
LkRkIFNlcHRlbWJlciAxOCwgMjAxNQotLkR0IFNSQy5DT05GIDUKKy5EdCBzcmMuY29uZiA1CiAu
T3MKIC5TaCBOQU1FCiAuTm0gc3JjLmNvbmYKQEAgLTEwLDE1ICsxMCwxNSBAQAogLlNoIERFU0NS
SVBUSU9OCiBUaGUKIC5ObQotZmlsZSBjb250YWlucyBzZXR0aW5ncyB0aGF0IHdpbGwgYXBwbHkg
dG8gZXZlcnkgYnVpbGQgaW52b2x2aW5nIHRoZQorZmlsZSBjb250YWlucyB2YXJpYWJsZXMgdGhh
dCBjb250cm9sIHdoYXQgY29tcG9uZW50cyB3aWxsIGJlIGdlbmVyYXRlZCBkdXJpbmcgdGhlIGJ1
aWxkIHByb2Nlc3MKK29mIHRoZQogLkZ4Ci1zb3VyY2UgdHJlZTsgc2VlCitzb3VyY2UgdHJlZSAo
L3Vzci9zcmMpOyBzZWUKIC5YciBidWlsZCA3IC4KIC5QcAogVGhlCiAuTm0KLWZpbGUgdXNlcyB0
aGUgc3RhbmRhcmQgbWFrZWZpbGUgc3ludGF4LgotSG93ZXZlciwKK2ZpbGUgdXNlcyB0aGUgc3Rh
bmRhcmQgbWFrZWZpbGUgc3ludGF4LiBIb3dldmVyLAogLk5tCiBzaG91bGQgbm90IHNwZWNpZnkg
YW55IGRlcGVuZGVuY2llcyB0bwogLlhyIG1ha2UgMSAuCkBAIC0zOSw4ICszOSw3IEBACiBPdmVy
cmlkaW5nIHRoZSBsb2NhdGlvbiBvZgogLk5tCiBtYXkgYmUgbmVjZXNzYXJ5IGlmIHRoZSBzeXN0
ZW0td2lkZSBzZXR0aW5ncyBhcmUgbm90IHN1aXRhYmxlCi1mb3IgYSBwYXJ0aWN1bGFyIGJ1aWxk
LgotRm9yIGluc3RhbmNlLCBzZXR0aW5nCitmb3IgYSBwYXJ0aWN1bGFyIGJ1aWxkLiBGb3IgaW5z
dGFuY2UsIHNldHRpbmcKIC5WYSBTUkNDT05GCiB0bwogLlBhIC9kZXYvbnVsbApAQCAtODIsOCAr
ODEsNyBAQAogLkRxIExpIEZBTFNFCiBvcgogLkRxIExpIE5PIC4KLUp1c3QgdGhlIGV4aXN0ZW5j
ZSBvZiBhbiBvcHRpb24gd2lsbCBjYXVzZQotaXQgdG8gYmUgaG9ub3VyZWQgYnkKK0p1c3QgdGhl
IGV4aXN0ZW5jZSBvZiBhbiBvcHRpb24gd2lsbCBjYXVzZSBpdCB0byBiZSBob25vdXJlZCBieQog
LlhyIG1ha2UgMSAuCiAuUHAKIFRoZSBmb2xsb3dpbmcgbGlzdCBwcm92aWRlcyBhIG5hbWUgYW5k
IHNob3J0IGRlc2NyaXB0aW9uIGZvciB2YXJpYWJsZXMKSW5kZXg6IG1hbjcvYnVpbGQuNwo9PT09
PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09
PT09PT09Ci0tLSBtYW43L2J1aWxkLjcJKHJldmlzaW9uIDI4OTQxMSkKKysrIG1hbjcvYnVpbGQu
Nwkod29ya2luZyBjb3B5KQpAQCAtMjUsMTEgKzI1LDExIEBACiAuXCIgJEZyZWVCU0QkCiAuXCIK
IC5EZCBEZWNlbWJlciAzMSwgMjAxNAotLkR0IEJVSUxEIDcKKy5EdCBCdWlsZCA3CiAuT3MKIC5T
aCBOQU1FCiAuTm0gYnVpbGQKLS5OZCBpbmZvcm1hdGlvbiBvbiBob3cgdG8gYnVpbGQgdGhlIHN5
c3RlbQorLk5kIEdlbmVyYWwgaW5zdHJ1Y3Rpb25zIG9uIGhvdyB0byBidWlsZCB0aGUgc3lzdGVt
CiAuU2ggREVTQ1JJUFRJT04KIFRoZSBzb3VyY2VzIGZvciB0aGUKIC5GeApAQCAtNjYsMzIgKzY2
LDMwIEBACiB0aGluZ3MgaW4gdGhhdCBkaXJlY3RvcnkuCiBJc3N1aW5nIHRoZQogLlhyIG1ha2Ug
MQotY29tbWFuZCBpbiBhbnkgZGlyZWN0b3J5IG9yCi1zdWJkaXJlY3Rvcnkgb2YgdGhvc2UgZGly
ZWN0b3JpZXMgaGFzIHRoZSBzYW1lIGVmZmVjdCBhcyBpc3N1aW5nIHRoZQotc2FtZSBjb21tYW5k
IGluIGFsbCBzdWJkaXJlY3RvcmllcyBvZiB0aGF0IGRpcmVjdG9yeS4KLVdpdGggbm8gdGFyZ2V0
IHNwZWNpZmllZCwgdGhlIHRoaW5ncyBpbiB0aGF0IGRpcmVjdG9yeSBhcmUganVzdCBidWlsdC4K
K2NvbW1hbmQgaW4gYW55IGRpcmVjdG9yeSBpc3N1ZXMgdGhlIAorLlhyIG1ha2UgMQorY29tbWFu
ZCByZWN1cnNpdmVseSBpbiBhbGwgc3ViZGlyZWN0b3JpZXMuCitXaXRoIG5vIHRhcmdldCBzcGVj
aWZpZWQsIHRoZSBpdGVtcyBpbiB0aGUgZGlyZWN0b3JpZXMgYXJlIGJ1aWx0IAorYW5kIG5vIGZ1
cnRoZXIgYWN0aW9uIGlzIHRha2VuLgogLlBwCi1BIHNvdXJjZSB0cmVlIGlzIGFsbG93ZWQgdG8g
YmUgcmVhZC1vbmx5LgotQXMgZGVzY3JpYmVkIGluCi0uWHIgbWFrZSAxICwKLW9iamVjdHMgYXJl
IHVzdWFsbHkgYnVpbHQgaW4gYSBzZXBhcmF0ZSBvYmplY3QgZGlyZWN0b3J5IGhpZXJhcmNoeQot
c3BlY2lmaWVkIGJ5IHRoZSBlbnZpcm9ubWVudCB2YXJpYWJsZQotLlZhIE1BS0VPQkpESVJQUkVG
SVggLAotb3IgdW5kZXIKK0Egc291cmNlIHRyZWUgaXMgYWxsb3dlZCB0byBiZSByZWFkLW9ubHkg
YXMgYWxsIGJ1aWxkIGFydGlmY2F0cyBnZW5lcmF0ZWQgYnkgCisuWHIgbWFrZSAxCithcmUgZ2Vu
ZXJhdGVkIGluIAogLlBhIC91c3Ivb2JqCi1pZiB2YXJpYWJsZQorYnkgZGVmYXVsdC4gVGhlIGRl
c3RpbmF0aW9uIGRpcmVjdG9yeSBjYW4gYmUgY2hhbmdlZCBieSBzcGVjaWZ5aW5nIAorYSBuZXcg
bG9jYXRpb24gdXNpbmcgCiAuVmEgTUFLRU9CSkRJUlBSRUZJWAotaXMgbm90IHNldC4KLUZvciBh
IGdpdmVuIHNvdXJjZSBkaXJlY3RvcnksIGl0cyBjYW5vbmljYWwgb2JqZWN0IGRpcmVjdG9yeQot
d291bGQgYmUKLS5QYSAke01BS0VPQkpESVJQUkVGSVh9JHsuQ1VSRElSfQotaWYKLS5YciBtYWtl
IDEKLXZhcmlhYmxlCithcyBkZXNjcmliZWQgaW4KKy5YciBtYWtlIDEgLgorCitUaGVyZWZvcmUs
IGZvciBhIGdpdmVuIHNvdXJjZSBkaXJlY3RvcnksIGl0cyBidWlsZCBhcnRpZmFjdHMgCit3b3Vs
ZCBiZSBnZW5lcmF0ZWQgaW4KKy5QYSAvdXNyL29iai8key5DVVJESVJ9CitvciB0bworLlBhICR7
TUFLRU9CSkRJUlBSRUZJWH0vJHsuQ1VSRElSfQorYWNjb3JkaW5nIHRvIHRoZSAKIC5WYSBNQUtF
T0JKRElSUFJFRklYCi1pcyBzZXQsIG9yCi0uUGEgL3Vzci9vYmokey5DVVJESVJ9Ci1pZiB0aGlz
IHZhcmlhYmxlIGlzIG5vdCBzZXQuCit2YXJpYWJsZS4KIENyb3NzLWJ1aWxkcyBzZXQgdGhlIG9i
amVjdCBkaXJlY3RvcnkgYXMgZGVzY3JpYmVkIGluIHRoZQogZG9jdW1lbnRhdGlvbiBmb3IgdGhl
CiAuQ20gYnVpbGR3b3JsZApAQCAtMTAyLDggKzEwMCwxNCBAQAogdmFyaWFibGVzIGRlc2NyaWJl
ZCBpbiB0aGUKIC5TeCBFTlZJUk9OTUVOVAogc2VjdGlvbiBiZWxvdywgYW5kIGJ5IHRoZSB2YXJp
YWJsZXMgZG9jdW1lbnRlZCBpbgotLlhyIG1ha2UuY29uZiA1IC4KKy5YciBtYWtlLmNvbmYgNSAu
IAogLlBwCitUaGUgZGVmYXVsdCBjb21wb25lbnRzIGluY2x1ZGVkIGluIHRoZSBidWlsZCBhcmUg
c3BlY2lmaWVkIGluIHRoZSBmaWxlIAorL2V0Yy9zcmMuY29uZiBpbiB0aGUgc291cmNlIHRyZWUu
IFRvIG92ZXJyaWRlIHRoZSBkZWZhdWx0IGZpbGUsIGluY2x1ZGUgCit0aGUgU1JDQ09ORiBvcHRp
b24gaW4gdGhlIG1ha2Ugc3RlcHMsIHBvaW50aW5nIHRvIGEgY3VzdG9tIHNyYy5jb25mIAorZmls
ZS4gRm9yIG1vcmUgaW5mb3JtYXRpb24gc2VlIAorLlhyIHNyYy5jb25mIDUgLgorLlBwCiBUaGUg
Zm9sbG93aW5nIGxpc3QgcHJvdmlkZXMgdGhlIG5hbWVzIGFuZCBhY3Rpb25zIGZvciB0aGUgdGFy
Z2V0cwogc3VwcG9ydGVkIGJ5IHRoZSBidWlsZCBzeXN0ZW06CiAuQmwgLXRhZyAtd2lkdGggIi5D
bSBjbGVhbmRlcGVuZCIKQEAgLTQ0NSw2ICs0NDksOSBAQAogLkJkIC1saXRlcmFsIC1vZmZzZXQg
aW5kZW50CiBtYWtlIFBPUlRTX01PRFVMRVM9ZW11bGF0b3JzL2txZW11LWttb2Qga2VybmVsCiAu
RWQKKy5JdCBWYSBTUkNDT05GCitTcGVjaWZ5IGEgZmlsZSB0byBvdmVycmlkZSB0aGUgZGVmYXVs
dCAvZXRjL3NyYy5jb25mLiBUaGUgc3JjLmNvbmYgZmlsZSBjb250cm9scyB0aGUgY29tcG9uZW50
cyB0byBidWlsZC4gU2VlIAorLlhyIFNSQy5DT05GIDUKIC5JdCBWYSBTVFJJUEJJTgogQ29tbWFu
ZCB0byB1c2UgYXQgaW5zdGFsbCB0aW1lIHdoZW4gc3RyaXBwaW5nIGJpbmFyaWVzLgogQmUgc3Vy
ZSB0byBhZGQgYW55IGFkZGl0aW9uYWwgdG9vbHMgcmVxdWlyZWQgdG8gcnVuCg==
--001a11438a8e6fcea2052246cf79--



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?CABx9NuQxmSJkceXa_5EdT3o8EaeYXU4G6B==UQVxi%2BPHhkQGtw>