Documentation: unify the spacing for questions in various places e.g. before the [Y/n] there should be a space, and before "?" there should be none. Unify the questions where the system expect an answer from the end user

Submitted by Gianfranco Costamagna on March 29, 2019, 9:32 a.m. | Patch ID: 159905

Details

Message ID 20190329093212.29347-1-costamagnagianfranco@yahoo.it
State New
Headers show

Commit Message

Gianfranco Costamagna March 29, 2019, 9:32 a.m.
Signed-off-by: Gianfranco Costamagna <costamagnagianfranco@yahoo.it>
Signed-off-by: Gianfranco Costamagna <locutusofborg@debian.org>
---
 documentation/kernel-dev/kernel-dev-common.xml                | 2 +-
 documentation/sdk-manual/sdk-extensible.xml                   | 2 +-
 documentation/sdk-manual/sdk-using.xml                        | 2 +-
 meta/files/toolchain-shar-extract.sh                          | 4 ++--
 .../initrdscripts/files/init-install-efi-testfs.sh            | 2 +-
 5 files changed, 6 insertions(+), 6 deletions(-)

Patch hide | download patch | download mbox

diff --git a/documentation/kernel-dev/kernel-dev-common.xml b/documentation/kernel-dev/kernel-dev-common.xml
index 7ff4cba3b0..7d8826fa35 100644
--- a/documentation/kernel-dev/kernel-dev-common.xml
+++ b/documentation/kernel-dev/kernel-dev-common.xml
@@ -185,7 +185,7 @@ 
      Poky (Yocto Project Reference Distro) Extensible SDK installer version &DISTRO;
      ============================================================================
      Enter target directory for SDK (default: ~/poky_sdk):
-     You are about to install the SDK to "/home/scottrif/poky_sdk". Proceed[Y/n]? Y
+     You are about to install the SDK to "/home/scottrif/poky_sdk". Proceed [Y/n]? Y
      Extracting SDK......................................done
      Setting it up...
      Extracting buildtools...
diff --git a/documentation/sdk-manual/sdk-extensible.xml b/documentation/sdk-manual/sdk-extensible.xml
index 09f06088d2..9be082d8ba 100644
--- a/documentation/sdk-manual/sdk-extensible.xml
+++ b/documentation/sdk-manual/sdk-extensible.xml
@@ -157,7 +157,7 @@ 
      Poky (Yocto Project Reference Distro) Extensible SDK installer version 2.5
      ==========================================================================
      Enter target directory for SDK (default: ~/poky_sdk):
-     You are about to install the SDK to "/home/scottrif/poky_sdk". Proceed[Y/n]? Y
+     You are about to install the SDK to "/home/scottrif/poky_sdk". Proceed [Y/n]? Y
      Extracting SDK..............done
      Setting it up...
      Extracting buildtools...
diff --git a/documentation/sdk-manual/sdk-using.xml b/documentation/sdk-manual/sdk-using.xml
index dd220c340b..06fdb573ed 100644
--- a/documentation/sdk-manual/sdk-using.xml
+++ b/documentation/sdk-manual/sdk-using.xml
@@ -149,7 +149,7 @@ 
      Poky (Yocto Project Reference Distro) SDK installer version &DISTRO;
      ===============================================================
      Enter target directory for SDK (default: /opt/poky/&DISTRO;):
-     You are about to install the SDK to "/opt/poky/&DISTRO;". Proceed[Y/n]? Y
+     You are about to install the SDK to "/opt/poky/&DISTRO;". Proceed [Y/n]? Y
      Extracting SDK........................................ ..............................done
      Setting it up...done
      SDK has been successfully set up and is ready to be used.
diff --git a/meta/files/toolchain-shar-extract.sh b/meta/files/toolchain-shar-extract.sh
index 9eabd62630..156085b500 100644
--- a/meta/files/toolchain-shar-extract.sh
+++ b/meta/files/toolchain-shar-extract.sh
@@ -185,11 +185,11 @@  fi
 
 if [ -e "$target_sdk_dir/environment-setup-@REAL_MULTIMACH_TARGET_SYS@" ]; then
 	echo "The directory \"$target_sdk_dir\" already contains a SDK for this architecture."
-	printf "If you continue, existing files will be overwritten! Proceed[y/N]? "
+	printf "If you continue, existing files will be overwritten! Proceed [y/N]? "
 
 	default_answer="n"
 else
-	printf "You are about to install the SDK to \"$target_sdk_dir\". Proceed[Y/n]? "
+	printf "You are about to install the SDK to \"$target_sdk_dir\". Proceed [Y/n]? "
 
 	default_answer="y"
 fi
diff --git a/meta/recipes-core/initrdscripts/files/init-install-efi-testfs.sh b/meta/recipes-core/initrdscripts/files/init-install-efi-testfs.sh
index 9c4b263d54..b351985a61 100644
--- a/meta/recipes-core/initrdscripts/files/init-install-efi-testfs.sh
+++ b/meta/recipes-core/initrdscripts/files/init-install-efi-testfs.sh
@@ -27,7 +27,7 @@  do
                 # Try sleeping here to avoid getting kernel messages
                 # obscuring/confusing user
                 sleep 5
-                echo "Found drive at /dev/${device}. Do you want to install this image there ? [y/n]"
+                echo "Found drive at /dev/${device}. Do you want to install this image there? [y/n]"
                 read answer
                 if [ "$answer" = "y" ] ; then
                     break

Comments

Scott Rifenbark April 2, 2019, 5:31 p.m.
Hi,

I applied changes for docs.  Someone else needs to get the changes into the
*.sh files.
See inline comments for links to adjusted text.

Scott

On Fri, Mar 29, 2019 at 2:33 AM Gianfranco Costamagna <
costamagna.gianfranco@gmail.com> wrote:

> Signed-off-by: Gianfranco Costamagna <costamagnagianfranco@yahoo.it>
> Signed-off-by: Gianfranco Costamagna <locutusofborg@debian.org>
> ---
>  documentation/kernel-dev/kernel-dev-common.xml                | 2 +-
>  documentation/sdk-manual/sdk-extensible.xml                   | 2 +-
>  documentation/sdk-manual/sdk-using.xml                        | 2 +-
>  meta/files/toolchain-shar-extract.sh                          | 4 ++--
>  .../initrdscripts/files/init-install-efi-testfs.sh            | 2 +-
>  5 files changed, 6 insertions(+), 6 deletions(-)
>
> diff --git a/documentation/kernel-dev/kernel-dev-common.xml
> b/documentation/kernel-dev/kernel-dev-common.xml
> index 7ff4cba3b0..7d8826fa35 100644
> --- a/documentation/kernel-dev/kernel-dev-common.xml
> +++ b/documentation/kernel-dev/kernel-dev-common.xml
> @@ -185,7 +185,7 @@
>       Poky (Yocto Project Reference Distro) Extensible SDK installer
> version &DISTRO;
>
> ============================================================================
>       Enter target directory for SDK (default: ~/poky_sdk):
> -     You are about to install the SDK to "/home/scottrif/poky_sdk".
> Proceed[Y/n]? Y
> +     You are about to install the SDK to "/home/scottrif/poky_sdk".
> Proceed [Y/n]? Y
>

See step 6 for this doc change -
https://yoctoproject.org/docs/2.7/kernel-dev/kernel-dev.html#getting-ready-to-develop-using-devtool


      Extracting SDK......................................done
>       Setting it up...
>       Extracting buildtools...
> diff --git a/documentation/sdk-manual/sdk-extensible.xml
> b/documentation/sdk-manual/sdk-extensible.xml
> index 09f06088d2..9be082d8ba 100644
> --- a/documentation/sdk-manual/sdk-extensible.xml
> +++ b/documentation/sdk-manual/sdk-extensible.xml
> @@ -157,7 +157,7 @@
>       Poky (Yocto Project Reference Distro) Extensible SDK installer
> version 2.5
>
> ==========================================================================
>       Enter target directory for SDK (default: ~/poky_sdk):
> -     You are about to install the SDK to "/home/scottrif/poky_sdk".
> Proceed[Y/n]? Y
> +     You are about to install the SDK to "/home/scottrif/poky_sdk".
> Proceed [Y/n]? Y
>

See the output here -
https://yoctoproject.org/docs/2.7/sdk-manual/sdk-manual.html#sdk-installing-the-extensible-sdk


      Extracting SDK..............done
>       Setting it up...
>       Extracting buildtools...
> diff --git a/documentation/sdk-manual/sdk-using.xml
> b/documentation/sdk-manual/sdk-using.xml
> index dd220c340b..06fdb573ed 100644
> --- a/documentation/sdk-manual/sdk-using.xml
> +++ b/documentation/sdk-manual/sdk-using.xml
> @@ -149,7 +149,7 @@
>       Poky (Yocto Project Reference Distro) SDK installer version &DISTRO;
>       ===============================================================
>       Enter target directory for SDK (default: /opt/poky/&DISTRO;):
> -     You are about to install the SDK to "/opt/poky/&DISTRO;".
> Proceed[Y/n]? Y
> +     You are about to install the SDK to "/opt/poky/&DISTRO;". Proceed
> [Y/n]? Y
>

See the output here -
https://yoctoproject.org/docs/2.7/sdk-manual/sdk-manual.html#sdk-installing-the-sdk


      Extracting SDK........................................
> ..............................done
>       Setting it up...done
>       SDK has been successfully set up and is ready to be used.
> diff --git a/meta/files/toolchain-shar-extract.sh
> b/meta/files/toolchain-shar-extract.sh
> index 9eabd62630..156085b500 100644
> --- a/meta/files/toolchain-shar-extract.sh
> +++ b/meta/files/toolchain-shar-extract.sh
> @@ -185,11 +185,11 @@ fi
>
>  if [ -e "$target_sdk_dir/environment-setup-@REAL_MULTIMACH_TARGET_SYS@"
> ]; then
>         echo "The directory \"$target_sdk_dir\" already contains a SDK for
> this architecture."
> -       printf "If you continue, existing files will be overwritten!
> Proceed[y/N]? "
> +       printf "If you continue, existing files will be overwritten!
> Proceed [y/N]? "
>
>         default_answer="n"
>  else
> -       printf "You are about to install the SDK to \"$target_sdk_dir\".
> Proceed[Y/n]? "
> +       printf "You are about to install the SDK to \"$target_sdk_dir\".
> Proceed [Y/n]? "
>
>         default_answer="y"
>  fi
> diff --git
> a/meta/recipes-core/initrdscripts/files/init-install-efi-testfs.sh
> b/meta/recipes-core/initrdscripts/files/init-install-efi-testfs.sh
> index 9c4b263d54..b351985a61 100644
> --- a/meta/recipes-core/initrdscripts/files/init-install-efi-testfs.sh
> +++ b/meta/recipes-core/initrdscripts/files/init-install-efi-testfs.sh
> @@ -27,7 +27,7 @@ do
>                  # Try sleeping here to avoid getting kernel messages
>                  # obscuring/confusing user
>                  sleep 5
> -                echo "Found drive at /dev/${device}. Do you want to
> install this image there ? [y/n]"
> +                echo "Found drive at /dev/${device}. Do you want to
> install this image there? [y/n]"
>                  read answer
>                  if [ "$answer" = "y" ] ; then
>                      break
> --
> 2.17.1
>
> --
> _______________________________________________
> yocto mailing list
> yocto@yoctoproject.org
> https://lists.yoctoproject.org/listinfo/yocto
>