From 4783ead254f135d7d4753f3b60a6e41249f3be8a Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Fri, 20 Mar 2015 15:25:31 -0700
Subject: dev-manual: Applied review edits to section on hostname changing

Edits to the "Customizing an Image Hostname" section from Ross.
Updated the last paragraph to not imply incorrect information.

Fixes [YOCTO #7417]

(From yocto-docs rev: 8997be297077ee0052a5afbe50b9864cdef14058)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 .../dev-manual/dev-manual-common-tasks.xml         | 24 ++++++++++++----------
 1 file changed, 13 insertions(+), 11 deletions(-)

(limited to 'documentation')

diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index ba74e15d1a..3e48c0add5 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -1175,7 +1175,7 @@
             <title>Customizing an Image Hostname</title>
 
             <para>
-                By default the configured hostname (i.e.
+                By default, the configured hostname (i.e.
                 <filename>/etc/hostname</filename>) in an image is the
                 same as the machine name.
                 For example, if
@@ -1186,12 +1186,9 @@
 
             <para>
                 You can customize this name by altering the value of the
-                "hostname" variable in the base-files recipe using either
+                "hostname" variable in the
+                <filename>base-files</filename> recipe using either
                 an append file or a configuration file.
-                <note>
-                    Setting the variable to "" causes no hostname to be
-                    written to <filename>/etc/hostname</filename>.
-                </note>
                 Use the following in an append file:
                 <literallayout class='monospaced'>
      hostname="myhostname"
@@ -1218,11 +1215,16 @@
             </para>
 
             <para>
-                Another point of interest is that if you leave the variable
-                "hostname" unset, the image will have no default hostname
-                in the filesystem.
-                This condition is suitable for environments that use
-                dynamic hostnames such as virtual machines.
+                Another point of interest is that if you unset the variable,
+                the image will have no default hostname in the filesystem.
+                Here is an example that unsets the variable in a
+                configuration file:
+                <literallayout class='monospaced'>
+     hostname_pn-base-files = ""
+                </literallayout>
+                Having no default hostname in the filesystem is suitable for
+                environments that use dynamic hostnames such as virtual
+                machines.
             </para>
         </section>
     </section>
-- 
cgit v1.2.3-54-g00ecf