Skip to content

Commit a65506e

Browse files
authored
Merge pull request #358 from bergerhoffer/github-334-ip
GitHub-334: Adding details and RFCs for IP address ranges
2 parents 6f9dacf + a4a0caa commit a65506e

File tree

1 file changed

+47
-5
lines changed

1 file changed

+47
-5
lines changed

supplementary_style_guide/style_guidelines/code-commands.adoc

Lines changed: 47 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,56 @@ If you include a shell prompt to indicate that a user with root privileges must
2929
[[ip-addresses-and-mac-addresses]]
3030
== IP addresses and MAC addresses
3131

32-
Use the IP and MAC address ranges that are reserved for documentation purposes to avoid the likelihood of conflicts and confusion:
32+
Use the IP and MAC address ranges that are reserved for documentation purposes to avoid the likelihood of conflicts and confusion.
3333

34-
* Reserved IP address ranges: See the _IBM Style_ guide for the list of reserved IP address ranges to use in documentation.
34+
[[reserved-ip-addresses]]
35+
=== Reserved IP addresses
3536

36-
* Reserved MAC addresses (defined in link:https://www.rfc-editor.org/rfc/rfc7042.html#section-2.1.2[RFC 7042]):
37+
Reserved IPv4 addresses for documentation are defined in link:https://www.rfc-editor.org/rfc/rfc5737.html[RFC 5737]:
3738

38-
** For unicast: 00:00:5E:00:53:00 - 00:00:5E:00:53:FF
39-
** For multicast: 01:00:5E:90:10:00 - 01:00:5E:90:10:FF
39+
[cols="1,1,1", options="header"]
40+
|===
41+
|Network
42+
|Subnet mask
43+
|Assignable addresses
44+
45+
|192.0.2.0
46+
|24
47+
|192.0.2.1 - 192.0.2.254
48+
49+
|198.51.100.0
50+
|24
51+
|198.51.100.1 - 198.51.100.254
52+
53+
|203.0.113.0
54+
|24
55+
|203.0.113.1 - 203.0.113.254
56+
|===
57+
58+
Reserved IPv6 addresses for documentation are defined in link:https://www.rfc-editor.org/rfc/rfc3849.html[RFC 3849]:
59+
60+
[cols="1,1,1", options="header"]
61+
|===
62+
|Network
63+
|Prefix
64+
|Assignable addresses
65+
66+
|2001:0DB8::
67+
(long form: 2001:0DB8:0:0:0:0:0:0)
68+
|32
69+
|2001:0db8:0000:0000:0000:0000:0000:0000 - 2001:0db8:ffff:ffff:ffff:ffff:ffff:ffff
70+
71+
|===
72+
73+
See the _IBM Style_ guide for additional guidance on using IP addresses in documentation.
74+
75+
[[reserved-mac-addresses]]
76+
=== Reserved MAC addresses
77+
78+
Reserved MAC addresses for documentation are defined in link:https://www.rfc-editor.org/rfc/rfc7042.html#section-2.1.2[RFC 7042]:
79+
80+
* For unicast: 00:00:5E:00:53:00 - 00:00:5E:00:53:FF
81+
* For multicast: 01:00:5E:90:10:00 - 01:00:5E:90:10:FF
4082

4183
[[long-code-examples]]
4284
== Long code examples

0 commit comments

Comments
 (0)