Skip to content

Add 64-bit architecture guidance #547

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
julian-cable merged 3 commits into from
Nov 28, 2023
Merged

Add 64-bit architecture guidance #547

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
de66f43
Add 64-bit architecture guidance
julian-cable Nov 23, 2023
5179d3c
Implementing edits from review
julian-cable Nov 27, 2023
04c8f45
Merge branch 'dev' into jcable/6.2-64bit
julian-cable Nov 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions en-US/0-9.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,77 @@

</varlistentry>

<varlistentry id="a64-bit">
<term role="true">64-bit ARM</term>
<listitem>
<para>
<emphasis>n.</emphasis> A 64-bit version of the ARM architecture.
This term can refer to both AArch66/`aarch64` and to ARM64/`arm64`.
</para>
<para>
Use this format in general cases to refer to names of the architecture for various cloud providers.
</para>
<para>
Cloud providers might use different formats of this term to refer to architectures.
If you are documenting code, commands, or outputs, then confer with your subject-matter expert on the correct format for the specific use case.
</para>
<para>
Examples:
</para>
<itemizedlist>
<listitem>
<para>
Amazon Web Services (AWS) on 64-bit ARM systems
</para>
</listitem>
<listitem>
<para>
Machine types for Microsoft Azure on 64-bit ARM infrastructures
</para>
</listitem>
</itemizedlist>
<para>
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"/>.
</para>

</listitem>

</varlistentry>
<varlistentry id="a64-bit-x86">
<term role="true">64-bit x86</term>
<listitem>
<para>
<emphasis>n.</emphasis> A 64-bit version of the x86 architecture.
This term is a synonym of x86_64.
Use this format in general cases to refer to names of the architecture for various cloud providers.
</para>
<para>
Cloud providers might use different formats of this term to refer to architectures.
If you are documenting code, commands or outputs, then confer with your subject-matter expert on the correct format for the specific use case.
</para>
<para>
Examples:
</para>
<itemizedlist>
<listitem>
<para>
Amazon Web Services (AWS) on 64-bit x86 systems
</para>
</listitem>
<listitem>
<para>
Machine types for Microsoft Azure on 64-bit x86 infrastructures
</para>
</listitem>
</itemizedlist>
<para>
Refer also to <xref linkend="a64-bit"/>, <xref linkend="aarch64"/>, <xref linkend="AMD64"/>, <xref linkend="ARM64"/>, <xref linkend="Intel64"/>, and <xref linkend="x86-64"/>.
</para>

</listitem>

</varlistentry>

</variablelist>
</chapter>

116 changes: 109 additions & 7 deletions en-US/A.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,33 +102,135 @@

</listitem>

</varlistentry>
<varlistentry id="aarch64">
<term role="true">AArch64, aarch64</term>
<listitem>
<para>
<emphasis>n.</emphasis> A 64-bit version of the ARM architecture.
Use this term when referring to operating systems and server instances, for example Red&nbsp;Hat Enterprise Linux, Fedora, CoreOS, and other Linux distributions.
</para>
<para>
Use the uppercase (AArch64) format in general cases when referring to system architecture.
Use the lowercase (aarch64) format only when referring to objects or parameters.
It can be styled as code (monospace font or a code-styled block) when referring to code.
</para>
<para>
Cloud providers might use different formats of this term to refer to architectures.
If you are documenting code, commands, or outputs, then confer with your subject-matter expert on the correct format for the specific use case.
</para>
<para>
Examples:
</para>
<itemizedlist>
<listitem>
<para>
When running Red&nbsp;Hat Enterprise Linux with an AArch64 system, run the following commands:
</para>
</listitem>
<listitem>
<para>
Specify the system architecture of your cluster, such as <code>x86_64</code> or <code>aarch64</code>.
</para>
</listitem>
</itemizedlist>
<para>
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"/>.
</para>

</listitem>

</varlistentry>
<varlistentry id="AMD64">
<term role="true">AMD64</term>
<term role="true">AMD64, amd64</term>
<listitem>
<para>
Correct. Do not use "Hammer", "x86_64", "x86-64", "x64", "64-bit x86" or other variations as the name of this architecture.
<emphasis>n.</emphasis> The AMD 64-bit version of the x86 architecture.
Use this term for Red&nbsp;Hat OpenShift Container Platform attributes, Kubernetes, operators, application programming interfaces (APIs), or command-line interface (CLI) objects.
</para>
<para>
The correct term for AMD's implementation of this architecture is "AMD64".
When discussing the architecture generally, reference both AMD64 and Intel 64 implementations specifically.
Use the uppercase format (AMD64) in general sentences when referring to Red&nbsp;Hat OpenShift Container Platform features.
Use the lowercase format (amd64) only when referring to objects or parameters.
It can be styled as code (monospace font or a code-styled block) when referring to code.
</para>
<para>
Cloud providers might use different formats of this term to refer to architectures.
If you are documenting code, commands, or outputs, then confer with your subject-matter expert on the correct format for the specific use case.
</para>
<para>
Examples:
</para>
<itemizedlist>
<listitem>
<para>
This operator is supported on AMD64 and ARM64 platforms.
</para>
</listitem>
<listitem>
<para>
In this scenario, <code>amd64</code> is a valid value for X.
</para>
</listitem>
</itemizedlist>
<!-- <para>
The correct term for AMD's implementation of this architecture is "AMD64".
When discussing the architecture generally, reference both AMD64 and Intel 64 implementations specifically.
</para> -->
<para>
Refer also to <xref linkend="Intel64"/>.
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"/>.
</para>
<note>
<!-- <note>
<para>
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" />.
</para>
<para>
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" />.
</para>

</note>
</note> -->

</listitem>

</varlistentry>
<varlistentry id="ARM64">
<term role="true">ARM64, arm64</term>
<listitem>
<para>
<emphasis>n.</emphasis> A 64-bit version of the ARM architecture.
Use this term for Red&nbsp;Hat OpenShift Container Platform attributes, Kubernetes, operators, application programming interfaces (APIs), and command-line interface (CLI) objects.
</para>
<para>
Use the uppercase format (ARM64) in general sentences when referring to Red&nbsp;Hat OpenShift Container Platform features.
Use lowercase format (arm64) only when referring to objects or parameters.
It can be styled as code (monospace font or a code-styled block) when referring to code.
</para>
<para>
Cloud providers might use different formats of this term to refer to architectures.
If you are documenting code, commands, or outputs, then confer with your subject-matter expert on the correct format for the specific use case.
</para>
<para>
Examples:
</para>
<itemizedlist>
<listitem>
<para>
In this exercise, you create an ARM64 compute machine set.
</para>
</listitem>
<listitem>
<para>
In this scenario, <code>arm64</code> is a valid value for X.
</para>
</listitem>
</itemizedlist>
<para>
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"/>.
</para>

</listitem>

</varlistentry>

<varlistentry id="andor">
<term role="false">and/or</term>
<listitem>
Expand Down
31 changes: 24 additions & 7 deletions en-US/I.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,24 +134,41 @@
<term role="true">Intel 64</term>
<listitem>
<para>
Correct.
<emphasis>n.</emphasis> The Intel 64-bit version of the x86 architecture.
Use this format when referring to information that is exclusive to Intel processors.
For Red&nbsp;Hat products, use only for Red&nbsp;Hat Enterprise Linux content.
</para>
<para>
Cloud providers might use different formats of this term to refer to architectures.
If you are documenting code, commands, or outputs, then confer with your subject-matter expert on the correct format for the specific use case.
</para>
<para>
Example:
</para>
<itemizedlist>
<listitem>
<para>
This feature can run on only Intel 64 processors.
</para>
</listitem>
</itemizedlist>
<!-- <para>
Do not use "Hammer", "x86_64", "x86-64", "x64", "64-bit x86", or other variations as the name of this architecture.
</para>
<para>
The correct term for Intel's implementation of this architecture is "Intel&reg;&nbsp;64".
When discussing the architecture generally, reference both AMD64 and Intel 64 implementations specifically.
</para>
</para> -->
<para>
Refer also to <xref linkend="AMD64"/>.
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"/>.
</para>
<note>
<para>
<!-- <para>
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" />.
</para>
<!-- Updated URL for AMD trademarks. -->
</para> -->
<para>
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" />.
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" />.
</para>

</note>
Expand Down
35 changes: 35 additions & 0 deletions en-US/XYZ.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,41 @@
</listitem>

</varlistentry>
<varlistentry id="x86-64">
<term role="true">x86_64</term>
<listitem>
<para>
<emphasis>n.</emphasis> A 64-bit version of the x86 architecture.
Use this term when referring to operating systems and server instances, for example Red&nbsp;Hat Enterprise Linux, Fedora, CoreOS and other Linux distributions.
Use this format without backticks in general cases when referring to system architecture.
Use this format in backticks when referring to architecture as a value or parameter.
</para>
<para>
Cloud providers might use different formats of this term to refer to architectures.
If you are documenting code, commands or outputs, then confer with your subject-matter expert on the correct format for the specific use case.
</para>
<para>
Examples:
</para>
<itemizedlist>
<listitem>
<para>
Specifies the type of architecture for your server, such as x86_64.
</para>
</listitem>
<listitem>
<para>
When specifying the architecture, <code>x86_64</code> is a valid value.
</para>
</listitem>
</itemizedlist>
<para>
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"/>.
</para>

</listitem>

</varlistentry>
<varlistentry id="xyxemacs">
<term>XEmacs</term>
<listitem>
Expand Down