diff options
Diffstat (limited to 'documentation/content/en/books/developers-handbook')
6 files changed, 22 insertions, 22 deletions
diff --git a/documentation/content/en/books/developers-handbook/_index.adoc b/documentation/content/en/books/developers-handbook/_index.adoc index b25ae41a62..b4979f3a2f 100644 --- a/documentation/content/en/books/developers-handbook/_index.adoc +++ b/documentation/content/en/books/developers-handbook/_index.adoc @@ -55,6 +55,6 @@ Many sections do not yet exist and some of those that do exist need to be update If you are interested in helping with this project, send email to the {freebsd-doc}. The latest version of this document is always available from the link:https://www.FreeBSD.org[FreeBSD World Wide Web server]. -It may also be downloaded in a variety of formats and compression options from the link:https://download.freebsd.org/doc/[FreeBSD download server] or one of the numerous extref:{handbook}[mirror sites, mirrors]. +It may also be downloaded in a variety of formats and compression options from the link:https://download.freebsd.org/doc/[FreeBSD download server] or one of the numerous extref:{handbook}mirrors[mirror sites, mirrors]. ''' diff --git a/documentation/content/en/books/developers-handbook/book.adoc b/documentation/content/en/books/developers-handbook/book.adoc index 63a89edddc..510467b290 100644 --- a/documentation/content/en/books/developers-handbook/book.adoc +++ b/documentation/content/en/books/developers-handbook/book.adoc @@ -53,7 +53,7 @@ Many sections do not yet exist and some of those that do exist need to be update If you are interested in helping with this project, send email to the {freebsd-doc}. The latest version of this document is always available from the link:https://www.FreeBSD.org[FreeBSD World Wide Web server]. -It may also be downloaded in a variety of formats and compression options from the link:https://download.freebsd.org/doc/[FreeBSD download server] or one of the numerous extref:{handbook}[mirror sites, mirrors]. +It may also be downloaded in a variety of formats and compression options from the link:https://download.freebsd.org/doc/[FreeBSD download server] or one of the numerous extref:{handbook}mirrors[mirror sites, mirrors]. ''' diff --git a/documentation/content/en/books/developers-handbook/ipv6/_index.adoc b/documentation/content/en/books/developers-handbook/ipv6/_index.adoc index a97feddf59..e80cf22dbd 100644 --- a/documentation/content/en/books/developers-handbook/ipv6/_index.adoc +++ b/documentation/content/en/books/developers-handbook/ipv6/_index.adoc @@ -80,7 +80,7 @@ We also attended University of New Hampshire IOL tests (http://www.iol.unh.edu/[ ** IPv4 compatible address is not supported. ** automatic tunneling (described in 4.3 of this RFC) is not supported. ** man:gif[4] interface implements IPv[46]-over-IPv[46] tunnel in a generic way, - and it covers "configured tunnel" described in the spec. See crossref:ipv6[gif,23.5.1.5] in this document for details. + and it covers "configured tunnel" described in the spec. See crossref:ipv6[gif,Generic Tunnel Interface] in this document for details. * RFC1981: Path MTU Discovery for IPv6 * RFC2080: RIPng for IPv6 @@ -114,15 +114,15 @@ We also attended University of New Hampshire IOL tests (http://www.iol.unh.edu/[ * RFC2460: IPv6 specification * RFC2461: Neighbor discovery for IPv6 -** See crossref:ipv6[neighbor-discovery,23.5.1.2] in this document for details. +** See crossref:ipv6[neighbor-discovery,Neighbor Discovery] in this document for details. * RFC2462: IPv6 Stateless Address Autoconfiguration -** See crossref:ipv6[ipv6-pnp,23.5.1.4] in this document for details. +** See crossref:ipv6[ipv6-pnp,Plug and Play] in this document for details. * RFC2463: ICMPv6 for IPv6 specification -** See crossref:ipv6[icmpv6,23.5.1.9] in this document for details. +** See crossref:ipv6[icmpv6,ICMPv6] in this document for details. * RFC2464: Transmission of IPv6 Packets over Ethernet Networks * RFC2465: MIB for IPv6: Textual Conventions and General Group @@ -138,11 +138,11 @@ We also attended University of New Hampshire IOL tests (http://www.iol.unh.edu/[ * RFC2553: Basic Socket Interface Extensions for IPv6 ** IPv4 mapped address (3.7) and special behavior of IPv6 wildcard bind socket - (3.8) are supported. See crossref:ipv6[ipv6-wildcard-socket,23.5.1.12] in this document for details. + (3.8) are supported. See crossref:ipv6[ipv6-wildcard-socket,IPv4 Mapped Address and IPv6 Wildcard Socket] in this document for details. * RFC2675: IPv6 Jumbograms -** See crossref:ipv6[ipv6-jumbo,23.5.1.7] in this document for details. +** See crossref:ipv6[ipv6-jumbo,Jumbo Payload] in this document for details. * RFC2710: Multicast Listener Discovery for IPv6 * RFC2711: IPv6 router alert option @@ -156,7 +156,7 @@ We also attended University of New Hampshire IOL tests (http://www.iol.unh.edu/[ * [.filename]#draft-itojun-ipv6-tcp-to-anycast-00#: Disconnecting TCP connection toward IPv6 anycast address * [.filename]#draft-yamamoto-wideipv6-comm-model-00# -** See crossref:ipv6[ipv6-sas,23.5.1.6] in this document for details. +** See crossref:ipv6[ipv6-sas,Source Address Selection] in this document for details. * [.filename]#draft-ietf-ipngwg-scopedaddr-format-00.txt#: An Extension of Format for IPv6 Scoped Addresses @@ -315,7 +315,7 @@ RFC2462 has validation rule against incoming RA prefix information option, in 5. This is to protect hosts from malicious (or misconfigured) routers that advertise very short prefix lifetime. There was an update from Jim Bound to ipngwg mailing list (look for "(ipng 6712)" in the archive) and it is implemented Jim's update. -See crossref:ipv6[neighbor-discovery,23.5.1.2] in the document for relationship between DAD and autoconfiguration. +See crossref:ipv6[neighbor-discovery,Neighbor Discovery] in the document for relationship between DAD and autoconfiguration. [[gif]] ==== Generic Tunnel Interface @@ -334,7 +334,7 @@ It is very easy to configure interfaces and routing tables to perform infinite l _Please be warned_. gif can be configured to be ECN-friendly. -See crossref:ipv6[ipsec-ecn,23.5.4.5] for ECN-friendliness of tunnels, and man:gif[4] for how to configure. +See crossref:ipv6[ipsec-ecn,ECN Consideration on IPsec Tunnels] for ECN-friendliness of tunnels, and man:gif[4] for how to configure. If you would like to configure an IPv4-in-IPv6 tunnel with gif interface, read man:gif[4] carefully. You will need to remove IPv6 link-local address automatically assigned to the gif interface. @@ -354,7 +354,7 @@ This is the most typical case. . If there is no address that satisfies the above condition, choose the address associated with the routing table entry for the destination. This is the last resort, which may cause scope violation. For instance, ::1 is selected for ff01::1, fe80:1::200:f8ff:fe01:6317 for -fe80:1::2a0:24ff:feab:839b (note that embedded interface index - described in crossref:ipv6[ipv6-scope-index,23.5.1.3] - helps us choose the right source address. +fe80:1::2a0:24ff:feab:839b (note that embedded interface index - described in crossref:ipv6[ipv6-scope-index,Scope Index] - helps us choose the right source address. Those embedded indices will not be on the wire). If the outgoing interface has multiple address for the scope, a source is selected longest match basis (rule 3). Suppose 2001:0DB8:808:1:200:f8ff:fe01:6317 and 2001:0DB8:9:124:200:f8ff:fe01:6317 are given to the outgoing interface. 2001:0DB8:808:1:200:f8ff:fe01:6317 is chosen as the source for the destination 2001:0DB8:800::1. diff --git a/documentation/content/en/books/developers-handbook/l10n/_index.adoc b/documentation/content/en/books/developers-handbook/l10n/_index.adoc index 5760eaef62..34153230f6 100644 --- a/documentation/content/en/books/developers-handbook/l10n/_index.adoc +++ b/documentation/content/en/books/developers-handbook/l10n/_index.adoc @@ -152,7 +152,7 @@ The below lines need to be put into a common header file of the program, which i #ifdef WITHOUT_NLS #define getstr(n) nlsstr[n] #else -#include nl_types.h +#include <nl_types.h> extern nl_catd catalog; #define getstr(n) catgets(catalog, 1, n, nlsstr[n]) @@ -166,7 +166,7 @@ Next, put these lines into the global declaration part of the main source file: [.programlisting] .... #ifndef WITHOUT_NLS -#include nl_types.h +#include <nl_types.h> nl_catd catalog; #endif @@ -209,7 +209,7 @@ First, here is an example that does not use libc error messages: [.programlisting] .... -#include err.h +#include <err.h> ... if (!S_ISDIR(st.st_mode)) errx(1, "argument is not a directory"); @@ -219,8 +219,8 @@ This can be transformed to print an error message by reading `errno` and printin [.programlisting] .... -#include err.h -#include errno.h +#include <err.h> +#include <errno.h> ... if (!S_ISDIR(st.st_mode)) { errno = ENOTDIR; @@ -236,7 +236,7 @@ It is worth to note that there are cases when `errno` is set automatically by a [.programlisting] .... -#include err.h +#include <err.h> ... if ((p = malloc(size)) == NULL) err(1, NULL); diff --git a/documentation/content/en/books/developers-handbook/tools/_index.adoc b/documentation/content/en/books/developers-handbook/tools/_index.adoc index bcae63ad03..14a6250329 100644 --- a/documentation/content/en/books/developers-handbook/tools/_index.adoc +++ b/documentation/content/en/books/developers-handbook/tools/_index.adoc @@ -105,7 +105,7 @@ Indeed, part of the original UNIX(R) philosophy was to provide lots of small uti Here is a list of interpreters that are available from the FreeBSD Ports Collection, with a brief discussion of some of the more popular interpreted languages. -Instructions on how to get and install applications from the Ports Collection can be found in the extref:{handbook}[Ports section, ports-using] of the handbook. +Instructions on how to get and install applications from the Ports Collection can be found in the extref:{handbook}ports[Ports section, ports-using] of the handbook. BASIC:: Short for Beginner's All-purpose Symbolic Instruction Code. @@ -939,7 +939,7 @@ Now all that is needed is to attach to the child, set PauseMode to `0` with `exp [NOTE] ==== The described functionality is available starting with LLDB version 12.0.0. -Users of FreeBSD releases containing an earlier LLDB version may wish to use the snapshot available in extref:{handbook}[ports or packages, ports-using], as package:devel/llvm-devel[]. +Users of FreeBSD releases containing an earlier LLDB version may wish to use the snapshot available in extref:{handbook}ports[ports or packages, ports-using], as package:devel/llvm-devel[]. ==== Starting with LLDB 12.0.0, remote debugging is supported on FreeBSD. diff --git a/documentation/content/en/books/developers-handbook/x86/_index.adoc b/documentation/content/en/books/developers-handbook/x86/_index.adoc index de7cd9e992..b0ca446359 100644 --- a/documentation/content/en/books/developers-handbook/x86/_index.adoc +++ b/documentation/content/en/books/developers-handbook/x86/_index.adoc @@ -171,7 +171,7 @@ open: int 80h .... -This convention has a great disadvantage over the UNIX(R) way, at least as far as assembly language programming is concerned: +This convention has a great disadvantage over the UNIX(R) way, at least as far as assembly language programming is concerned: Every time you make a kernel call you must `push` the registers, then `pop` them later. This makes your code bulkier and slower. Nevertheless, FreeBSD gives you a choice. @@ -2789,7 +2789,7 @@ Plus, this value is for the daylight only: Other types of light will require a d ==== The F-Number The f-number is a very useful measure of how much light reaches the film. -A light meter can determine that, for example, to expose a film of specific sensitivity with f5.6 mkay require the exposure to last 1/1000 sec. +A light meter can determine that, for example, to expose a film of specific sensitivity with f/5.6 may require the exposure to last 1/1000 sec. It does not matter whether it is a 35-mm camera, or a 6x9cm camera, etc. As long as we know the f-number, we can determine the proper exposure. |