Merge lp:~ikepanhc/installation-guide/1730322 into lp:~ubuntu-core-dev/installation-guide/ubuntu

[Ike Panhc]

Describe HWE kernel, point release and url for supported arm64 platform

[dann frazier (dannf)]

Thanks Ike! Sorry for the late review. Comments inline. I'd also ask that we get someone from the kernel team to +1 the MP, since we're describing their product.

review: Needs Fixing

Unmerged revisions

542. By Ike Panhc on 2017-11-07

Describe HWE kernel, point release and url for supported arm64 platform

=== modified file 'build/entities/urls.ent'
--- build/entities/urls.ent	2015-12-19 21:18:18 +0000
+++ build/entities/urls.ent	2017-11-07 08:05:00 +0000
@@ -48,12 +48,14 @@
 <!-- base for the current distribution -->
 <!ENTITY disturlftp "&url-debian-ftp;debian/dists/&releasename;/">
 <!ENTITY disturl    "&url-archive;dists/&releasename;/">
+<!ENTITY disturlhwe "&url-archive;dists/&releasename;-updates/">
 
 <!-- base for unstable -->
 <!ENTITY url-dist-unstable "&url-archive;dists/unstable/">
 
 <!-- where to get the current debian-installer -->
 <!ENTITY url-debian-installer "&disturl;main/installer-&architecture;/current/">
+<!ENTITY url-debian-installer-hwe "&disturlhwe;main/installer-&architecture;/current/">
 
 <!-- debian-installer WebSVN  -->
 <!ENTITY url-d-i-websvn "http://anonscm.debian.org/viewvc/d-i/">

=== modified file 'build/templates/docstruct.ent'
--- build/templates/docstruct.ent	2015-12-19 21:18:18 +0000
+++ build/templates/docstruct.ent	2017-11-07 08:05:00 +0000
@@ -40,6 +40,7 @@
  <!ENTITY preparing.xml     SYSTEM "##SRCPATH##/preparing/preparing.xml">
   <!ENTITY install-overview.xml        SYSTEM "##SRCPATH##/preparing/install-overview.xml">
   <!ENTITY backup.xml                  SYSTEM "##SRCPATH##/preparing/backup.xml">
+  <!ENTITY hwe.xml                     SYSTEM "##SRCPATH##/preparing/hwe.xml">
   <!ENTITY needed-info.xml             SYSTEM "##SRCPATH##/preparing/needed-info.xml">
   <!ENTITY minimum-hardware-reqts.xml  SYSTEM "##SRCPATH##/preparing/minimum-hardware-reqts.xml">
   <!ENTITY non-debian-partitioning.xml SYSTEM "##SRCPATH##/preparing/non-debian-partitioning.xml">

=== modified file 'debian/changelog'
--- debian/changelog	2016-06-20 17:47:17 +0000
+++ debian/changelog	2017-11-07 08:05:00 +0000
@@ -3,6 +3,9 @@
   [ Doug Smythies ]
   * Fix typos in phrases where the sentence end dot is doubled.
 
+  [ Ike Panhc ]
+  * Describe HWE kernel, point release and url for supported arm64 platform.
+
  -- Mathieu Trudel-Lapierre <[e-mail]>  Mon, 20 Jun 2016 13:46:34 -0400
 
 installation-guide (20160121ubuntu3) yakkety; urgency=medium

=== modified file 'en/hardware/supported/arm.xml'
--- en/hardware/supported/arm.xml	2016-06-03 21:55:24 +0000
+++ en/hardware/supported/arm.xml	2017-11-07 08:05:00 +0000
@@ -95,7 +95,7 @@
 
   </sect2>
 
-<sect2 arch="arm64" id="arm64-supported-platforms"><title>Platforms supported by &debian;/arm64</title>
+<sect2 arch="arm64" id="arm64-supported-platforms"><title>Supported arm64 platforms</title>
 
   <para>
     <phrase condition="not-ubuntu">Arm64/AArch64/ARMv8 hardware became
@@ -104,64 +104,13 @@
     support merged in the mainline kernel version by the time of this
     release; this is the main requirement to have &d-i; working on
     them. </phrase>
-    The following platforms are known to be supported by
-    &debian;/arm64 in this release. There is only one kernel image,
-    which supports all the listed platforms.
+    Ubuntu provides generic arm64 kernel images for various supported
+    platforms listed in
+    <ulink url="https://wiki.ubuntu.com/ARM/Server/Install">Ubuntu Wiki</ulink>.
+    You can check for installation guide for each platform for
+    system-specific installation instructions.
   </para>
 
-  <variablelist>
-      <varlistentry>
-        <term>Applied Micro (APM) Mustang/X-Gene</term>
-        <listitem>
-          <para>
-	    The APM Mustang was the first Linux-capable ARMv8 system
-	    available. It uses the X-gene SoC, which has since also
-	    been used in other machines. It is an 8-core CPU, with
-	    ethernet, USB and serial. A common form-factor looks just
-	    like a desktop PC box, but many other versions are
-	    expected in the future. Most of the hardware is supported
-	    in the mainline kernel, but at this point USB support is
-	    lacking in the &releasename-cap; kernel.
-          </para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term>ARM Juno Development Platform</term>
-        <listitem>
-          <para>	    
-	    Juno is a capable development board with a 6-core (2xA57,
-	    4xA53) ARMv8-A 800Mhz CPU, Mali (T624) graphics, 8GB DDR3
-	    RAM, Ethernet, USB, Serial. It was designed for system
-	    bring-up and power testing so is neither small nor cheap,
-	    but was one of the first boards available. All the
-	    on-board hardware is supported in the mainline kernel and
-	    in &releasename-cap;.
-          </para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term>Cavium ThunderX Reference Platforms CN8800-1S-CDK &amp; CN8800-2S-CDK</term>
-        <listitem>
-          <para>
-	    The ThunderX 1S Reference Platform is a 1U rack mount chassis with a
-	    Micro-ATX single socket motherboard supporting 10GE &amp; 40GE
-	    networking, x8 PCIe, 4 HDD drive slots and 8 DDR3 memory slots. The
-	    ThunderX 2S Reference Platform is a 2U rack mount chassis with a ½ SSI
-	    dual socket motherboard supporting 10GE &amp; 40GE networking, x8 PCIe,
-	    6 HDD drive slots and 8 DDR4 memory slots. The 2U chassis can
-	    accommodate 4 sleds and each of the sleds has a dual 48 core socket
-	    design (96 cores per sled).  The &releasename-cap; kernel has support
-	    for nearly all on-board hardware. Certain exceptions, such as the IPMI
-	    system interface (<filename>/dev/ipmi</filename>), may be supported in a
-	    future &releasename-cap; update.
-          </para>
-        </listitem>
-      </varlistentry>
-
-  </variablelist>
-
   <para>
     When using &d-i; on non-UEFI systems, you may have to manually
     make the system bootable at the end of the installation, e.g. by

=== modified file 'en/install-methods/downloading-files.xml'
--- en/install-methods/downloading-files.xml	2015-12-19 21:18:18 +0000
+++ en/install-methods/downloading-files.xml	2017-11-07 08:05:00 +0000
@@ -26,6 +26,10 @@
 lists each image and its purpose.
 </para>
 
+<para>
+The HWE installation images are located on each Ubuntu mirror in the directory <ulink url="&url-debian-installer-hwe;images/hwe-netboot/">ubuntu/dists/xenial-updates/main/installer-arm64/current/images/hwe-netboot/</ulink>
+</para>
+
 &download-arm.xml;
 &download-powerpc.xml;
 

=== added file 'en/preparing/hwe.xml'
--- en/preparing/hwe.xml	1970-01-01 00:00:00 +0000
+++ en/preparing/hwe.xml	2017-11-07 08:05:00 +0000
@@ -0,0 +1,20 @@
+ <sect1 id="point">
+ <title>Point release and HWE kernel</title>
+<para>
+
+The LTS release’s kernel is refreshed with a new, optional kernel at
+some point releases. This kernel is refered to as the Hardware
+Enablement (HWE) kernel, and provides support for new hardware that
+has been introduced after the LTS’s GA. New hardware components are
+supported by HWE kernels and on an installed system with proper
+networking you can install it by `apt install linux-generic-lts-hwe`. 
+
+</para><para>
+
+The LTS point releases also provide an updated installation kernel for
+scenarios where kernel support for key components, such as NIC or RAID
+cards, is required during the installation process.
+
+</para>
+
+ </sect1>

=== modified file 'en/preparing/preparing.xml'
--- en/preparing/preparing.xml	2015-12-19 21:18:18 +0000
+++ en/preparing/preparing.xml	2017-11-07 08:05:00 +0000
@@ -13,6 +13,7 @@
 
 &install-overview.xml;
 &backup.xml;
+&hwe.xml;
 &needed-info.xml;
 &minimum-hardware-reqts.xml;
 &non-debian-partitioning.xml;