Skip to content

Commit 1fb8f6c

Browse files
julian-cablejulian-cable
authored
Add 64-bit architecture guidance (#547)
* Add 64-bit architecture guidance * Implementing edits from review
1 parent 0c182df commit 1fb8f6c

File tree

4 files changed

+239
-14
lines changed

4 files changed

+239
-14
lines changed

‎en-US/0-9.xml

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,77 @@
3838

3939
</varlistentry>
4040

41+
<varlistentry id="a64-bit">
42+
<term role="true">64-bit ARM</term>
43+
<listitem>
44+
<para>
45+
<emphasis>n.</emphasis> A 64-bit version of the ARM architecture.
46+
This term can refer to both AArch66/`aarch64` and to ARM64/`arm64`.
47+
</para>
48+
<para>
49+
Use this format in general cases to refer to names of the architecture for various cloud providers.
50+
</para>
51+
<para>
52+
Cloud providers might use different formats of this term to refer to architectures.
53+
If you are documenting code, commands, or outputs, then confer with your subject-matter expert on the correct format for the specific use case.
54+
</para>
55+
<para>
56+
Examples:
57+
</para>
58+
<itemizedlist>
59+
<listitem>
60+
<para>
61+
Amazon Web Services (AWS) on 64-bit ARM systems
62+
</para>
63+
</listitem>
64+
<listitem>
65+
<para>
66+
Machine types for Microsoft Azure on 64-bit ARM infrastructures
67+
</para>
68+
</listitem>
69+
</itemizedlist>
70+
<para>
71+
Refer also to <xref linkend="a64-bit-x86"/>, <xref linkend="aarch64"/>, <xref linkend="AMD64"/>, <xref linkend="ARM64"/>, <xref linkend="Intel64"/>, and <xref linkend="x86-64"/>.
72+
</para>
73+
74+
</listitem>
75+
76+
</varlistentry>
77+
<varlistentry id="a64-bit-x86">
78+
<term role="true">64-bit x86</term>
79+
<listitem>
80+
<para>
81+
<emphasis>n.</emphasis> A 64-bit version of the x86 architecture.
82+
This term is a synonym of x86_64.
83+
Use this format in general cases to refer to names of the architecture for various cloud providers.
84+
</para>
85+
<para>
86+
Cloud providers might use different formats of this term to refer to architectures.
87+
If you are documenting code, commands or outputs, then confer with your subject-matter expert on the correct format for the specific use case.
88+
</para>
89+
<para>
90+
Examples:
91+
</para>
92+
<itemizedlist>
93+
<listitem>
94+
<para>
95+
Amazon Web Services (AWS) on 64-bit x86 systems
96+
</para>
97+
</listitem>
98+
<listitem>
99+
<para>
100+
Machine types for Microsoft Azure on 64-bit x86 infrastructures
101+
</para>
102+
</listitem>
103+
</itemizedlist>
104+
<para>
105+
Refer also to <xref linkend="a64-bit"/>, <xref linkend="aarch64"/>, <xref linkend="AMD64"/>, <xref linkend="ARM64"/>, <xref linkend="Intel64"/>, and <xref linkend="x86-64"/>.
106+
</para>
107+
108+
</listitem>
109+
110+
</varlistentry>
111+
41112
</variablelist>
42113
</chapter>
43114

‎en-US/A.xml

Lines changed: 109 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -102,33 +102,135 @@
102102

103103
</listitem>
104104

105+
</varlistentry>
106+
<varlistentry id="aarch64">
107+
<term role="true">AArch64, aarch64</term>
108+
<listitem>
109+
<para>
110+
<emphasis>n.</emphasis> A 64-bit version of the ARM architecture.
111+
Use this term when referring to operating systems and server instances, for example Red&nbsp;Hat Enterprise Linux, Fedora, CoreOS, and other Linux distributions.
112+
</para>
113+
<para>
114+
Use the uppercase (AArch64) format in general cases when referring to system architecture.
115+
Use the lowercase (aarch64) format only when referring to objects or parameters.
116+
It can be styled as code (monospace font or a code-styled block) when referring to code.
117+
</para>
118+
<para>
119+
Cloud providers might use different formats of this term to refer to architectures.
120+
If you are documenting code, commands, or outputs, then confer with your subject-matter expert on the correct format for the specific use case.
121+
</para>
122+
<para>
123+
Examples:
124+
</para>
125+
<itemizedlist>
126+
<listitem>
127+
<para>
128+
When running Red&nbsp;Hat Enterprise Linux with an AArch64 system, run the following commands:
129+
</para>
130+
</listitem>
131+
<listitem>
132+
<para>
133+
Specify the system architecture of your cluster, such as <code>x86_64</code> or <code>aarch64</code>.
134+
</para>
135+
</listitem>
136+
</itemizedlist>
137+
<para>
138+
Refer also to <xref linkend="a64-bit"/>, <xref linkend="a64-bit-x86"/>, <xref linkend="AMD64"/>, <xref linkend="ARM64"/>, <xref linkend="Intel64"/>, and <xref linkend="x86-64"/>.
139+
</para>
140+
141+
</listitem>
142+
105143
</varlistentry>
106144
<varlistentry id="AMD64">
107-
<term role="true">AMD64</term>
145+
<term role="true">AMD64, amd64</term>
108146
<listitem>
109147
<para>
110-
Correct. Do not use "Hammer", "x86_64", "x86-64", "x64", "64-bit x86" or other variations as the name of this architecture.
148+
<emphasis>n.</emphasis> The AMD 64-bit version of the x86 architecture.
149+
Use this term for Red&nbsp;Hat OpenShift Container Platform attributes, Kubernetes, operators, application programming interfaces (APIs), or command-line interface (CLI) objects.
111150
</para>
112151
<para>
113-
The correct term for AMD's implementation of this architecture is "AMD64".
114-
When discussing the architecture generally, reference both AMD64 and Intel 64 implementations specifically.
152+
Use the uppercase format (AMD64) in general sentences when referring to Red&nbsp;Hat OpenShift Container Platform features.
153+
Use the lowercase format (amd64) only when referring to objects or parameters.
154+
It can be styled as code (monospace font or a code-styled block) when referring to code.
155+
</para>
156+
<para>
157+
Cloud providers might use different formats of this term to refer to architectures.
158+
If you are documenting code, commands, or outputs, then confer with your subject-matter expert on the correct format for the specific use case.
159+
</para>
160+
<para>
161+
Examples:
115162
</para>
163+
<itemizedlist>
164+
<listitem>
165+
<para>
166+
This operator is supported on AMD64 and ARM64 platforms.
167+
</para>
168+
</listitem>
169+
<listitem>
170+
<para>
171+
In this scenario, <code>amd64</code> is a valid value for X.
172+
</para>
173+
</listitem>
174+
</itemizedlist>
175+
<!-- <para>
176+
The correct term for AMD's implementation of this architecture is "AMD64".
177+
When discussing the architecture generally, reference both AMD64 and Intel 64 implementations specifically.
178+
</para> -->
116179
<para>
117-
Refer also to <xref linkend="Intel64"/>.
180+
Refer also to <xref linkend="a64-bit"/>, <xref linkend="a64-bit-x86"/>, <xref linkend="aarch64"/>, <xref linkend="ARM64"/>, <xref linkend="Intel64"/>, and <xref linkend="x86-64"/>.
118181
</para>
119-
<note>
182+
<!-- <note>
120183
<para>
121184
The AMD64 logo is trademarked; the term "AMD64" is not. For more information about AMD trademarks, refer to the <citetitle>AMD Trademark Information</citetitle> page at <ulink url="https://www.amd.com/en/corporate/trademarks" />.
122185
</para>
123186
<para>
124187
For more information about Intel&reg; trademarks, refer to <ulink url="http://www.intel.com/content/www/us/en/legal/trademarks.html" /> and <ulink url="http://www.intel.com/content/www/us/en/trademarks/trademarks.html" />.
125188
</para>
126189
127-
</note>
190+
</note> -->
191+
192+
</listitem>
193+
194+
</varlistentry>
195+
<varlistentry id="ARM64">
196+
<term role="true">ARM64, arm64</term>
197+
<listitem>
198+
<para>
199+
<emphasis>n.</emphasis> A 64-bit version of the ARM architecture.
200+
Use this term for Red&nbsp;Hat OpenShift Container Platform attributes, Kubernetes, operators, application programming interfaces (APIs), and command-line interface (CLI) objects.
201+
</para>
202+
<para>
203+
Use the uppercase format (ARM64) in general sentences when referring to Red&nbsp;Hat OpenShift Container Platform features.
204+
Use lowercase format (arm64) only when referring to objects or parameters.
205+
It can be styled as code (monospace font or a code-styled block) when referring to code.
206+
</para>
207+
<para>
208+
Cloud providers might use different formats of this term to refer to architectures.
209+
If you are documenting code, commands, or outputs, then confer with your subject-matter expert on the correct format for the specific use case.
210+
</para>
211+
<para>
212+
Examples:
213+
</para>
214+
<itemizedlist>
215+
<listitem>
216+
<para>
217+
In this exercise, you create an ARM64 compute machine set.
218+
</para>
219+
</listitem>
220+
<listitem>
221+
<para>
222+
In this scenario, <code>arm64</code> is a valid value for X.
223+
</para>
224+
</listitem>
225+
</itemizedlist>
226+
<para>
227+
Refer also to <xref linkend="a64-bit"/>, <xref linkend="a64-bit-x86"/>, <xref linkend="aarch64"/>, <xref linkend="AMD64"/>, <xref linkend="Intel64"/>, and <xref linkend="x86-64"/>.
228+
</para>
128229

129230
</listitem>
130231

131232
</varlistentry>
233+
132234
<varlistentry id="andor">
133235
<term role="false">and/or</term>
134236
<listitem>

‎en-US/I.xml

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -134,24 +134,41 @@
134134
<term role="true">Intel 64</term>
135135
<listitem>
136136
<para>
137-
Correct.
137+
<emphasis>n.</emphasis> The Intel 64-bit version of the x86 architecture.
138+
Use this format when referring to information that is exclusive to Intel processors.
139+
For Red&nbsp;Hat products, use only for Red&nbsp;Hat Enterprise Linux content.
140+
</para>
141+
<para>
142+
Cloud providers might use different formats of this term to refer to architectures.
143+
If you are documenting code, commands, or outputs, then confer with your subject-matter expert on the correct format for the specific use case.
144+
</para>
145+
<para>
146+
Example:
147+
</para>
148+
<itemizedlist>
149+
<listitem>
150+
<para>
151+
This feature can run on only Intel 64 processors.
152+
</para>
153+
</listitem>
154+
</itemizedlist>
155+
<!-- <para>
138156
Do not use "Hammer", "x86_64", "x86-64", "x64", "64-bit x86", or other variations as the name of this architecture.
139157
</para>
140158
<para>
141159
The correct term for Intel's implementation of this architecture is "Intel&reg;&nbsp;64".
142160
When discussing the architecture generally, reference both AMD64 and Intel 64 implementations specifically.
143-
</para>
161+
</para> -->
144162
<para>
145-
Refer also to <xref linkend="AMD64"/>.
163+
Refer also to <xref linkend="a64-bit"/>, <xref linkend="a64-bit-x86"/>, <xref linkend="aarch64"/>, <xref linkend="AMD64"/>, <xref linkend="ARM64"/>, and <xref linkend="x86-64"/>.
146164
</para>
147165
<note>
148-
<para>
166+
<!-- <para>
149167
The AMD64 logo is trademarked; the term "AMD64" is not.
150168
For more information about AMD trademarks, refer to the <citetitle>AMD Trademark Information</citetitle> page at <ulink url="https://www.amd.com/en/corporate/trademarks" />.
151-
</para>
152-
<!-- Updated URL for AMD trademarks. -->
169+
</para> -->
153170
<para>
154-
For more information about Intel&reg; trademarks, refer to <ulink url="http://www.intel.com/content/www/us/en/legal/trademarks.html" /> and <ulink url="http://www.intel.com/content/www/us/en/trademarks/trademarks.html" />.
171+
For more information about Intel trademarks, refer to <ulink url="http://www.intel.com/content/www/us/en/legal/trademarks.html" /> and <ulink url="http://www.intel.com/content/www/us/en/trademarks/trademarks.html" />.
155172
</para>
156173

157174
</note>

‎en-US/XYZ.xml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,41 @@
1616
</listitem>
1717

1818
</varlistentry>
19+
<varlistentry id="x86-64">
20+
<term role="true">x86_64</term>
21+
<listitem>
22+
<para>
23+
<emphasis>n.</emphasis> A 64-bit version of the x86 architecture.
24+
Use this term when referring to operating systems and server instances, for example Red&nbsp;Hat Enterprise Linux, Fedora, CoreOS and other Linux distributions.
25+
Use this format without backticks in general cases when referring to system architecture.
26+
Use this format in backticks when referring to architecture as a value or parameter.
27+
</para>
28+
<para>
29+
Cloud providers might use different formats of this term to refer to architectures.
30+
If you are documenting code, commands or outputs, then confer with your subject-matter expert on the correct format for the specific use case.
31+
</para>
32+
<para>
33+
Examples:
34+
</para>
35+
<itemizedlist>
36+
<listitem>
37+
<para>
38+
Specifies the type of architecture for your server, such as x86_64.
39+
</para>
40+
</listitem>
41+
<listitem>
42+
<para>
43+
When specifying the architecture, <code>x86_64</code> is a valid value.
44+
</para>
45+
</listitem>
46+
</itemizedlist>
47+
<para>
48+
Refer also to <xref linkend="a64-bit"/>, <xref linkend="a64-bit-x86"/>, <xref linkend="aarch64"/>, <xref linkend="AMD64"/>, <xref linkend="ARM64"/>, and <xref linkend="Intel64"/>.
49+
</para>
50+
51+
</listitem>
52+
53+
</varlistentry>
1954
<varlistentry id="xyxemacs">
2055
<term>XEmacs</term>
2156
<listitem>

0 commit comments

Comments
 (0)