[PATCH v3] ref-manual: use standardized method accross both ubuntu and debian for locale install

[PATCH v3] ref-manual: use standardized method accross both ubuntu and debian for locale install

[Guénaël Muller]

Modify locale installation method to be standard accross all debian-based distributions.
Pre-existing method is available only on Ubuntu, locale-gen tool has no parameter in Debian.

Signed-off-by: Guénaël Muller <guenael.muller@smile.fr>
Reviewed-by: Yoann Congal <yoann.congal@smile.fr>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Tested-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/poky.yaml.in                       |  3 +--
 documentation/ref-manual/system-requirements.rst | 14 ++++++++++++++
 2 files changed, 15 insertions(+), 2 deletions(-)

diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
index c770318f2..66f758fe8 100644
--- a/documentation/poky.yaml.in
+++ b/documentation/poky.yaml.in
@@ -13,8 +13,7 @@ YOCTO_RELEASE_DL_URL : "&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;"
 UBUNTU_HOST_PACKAGES_ESSENTIAL : "gawk wget git diffstat unzip texinfo gcc \
      build-essential chrpath socat cpio python3 python3-pip python3-pexpect \
      xz-utils debianutils iputils-ping python3-git python3-jinja2 \
-     python3-subunit zstd liblz4-tool file locales libacl1
-     \n\   $ sudo locale-gen en_US.UTF-8"
+     python3-subunit zstd liblz4-tool file locales libacl1"
 FEDORA_HOST_PACKAGES_ESSENTIAL : "gawk make wget tar bzip2 gzip python3 unzip perl patch \
      diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath \
      ccache perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue perl-bignum socat \
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
index 0fc92550a..f53b9fdbd 100644
--- a/documentation/ref-manual/system-requirements.rst
+++ b/documentation/ref-manual/system-requirements.rst
@@ -152,8 +152,22 @@ with a supported Ubuntu or Debian Linux distribution::
 
    $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL;
 
+You also need to ensure you have the ``en_US.UTF-8`` locale enabled::
+
+   $ locale --all-locales | grep en_US.utf8
+
+If this is not the case, you can reconfigure the ``locales`` package to add it (interactive mode only)::
+
+   $ sudo dpkg-reconfigure locales
+
 .. note::
 
+   -  If your are not using the interactive mode, ``dpkg-reconfigure`` will not work as expected. To add the locale
+      you will need to edit ``/etc/locale.gen`` file to add/uncomment the ``en_US.UTF-8`` locale. A naive way to do this as root is::
+
+         $ echo "en_US.UTF-8 UTF-8" >> /etc/locale.gen
+         $ locale-gen
+
    -  If your build system has the ``oss4-dev`` package installed, you
       might experience QEMU build failures due to the package installing
       its own custom ``/usr/include/linux/soundcard.h`` on the Debian
-- 
2.39.5

Re: [PATCH v3] ref-manual: use standardized method accross both ubuntu and debian for locale install

[Antonin Godard]

Hi Guénaël,

On Fri Nov 29, 2024 at 11:36 AM CET, Guénaël Muller wrote:
> Modify locale installation method to be standard accross all debian-based distributions.
> Pre-existing method is available only on Ubuntu, locale-gen tool has no parameter in Debian.
>
> Signed-off-by: Guénaël Muller <guenael.muller@smile.fr>
> Reviewed-by: Yoann Congal <yoann.congal@smile.fr>
> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
> Tested-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>  documentation/poky.yaml.in                       |  3 +--
>  documentation/ref-manual/system-requirements.rst | 14 ++++++++++++++
>  2 files changed, 15 insertions(+), 2 deletions(-)
>
> diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
> index c770318f2..66f758fe8 100644
> --- a/documentation/poky.yaml.in
> +++ b/documentation/poky.yaml.in
> @@ -13,8 +13,7 @@ YOCTO_RELEASE_DL_URL : "&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;"
>  UBUNTU_HOST_PACKAGES_ESSENTIAL : "gawk wget git diffstat unzip texinfo gcc \
>       build-essential chrpath socat cpio python3 python3-pip python3-pexpect \
>       xz-utils debianutils iputils-ping python3-git python3-jinja2 \
> -     python3-subunit zstd liblz4-tool file locales libacl1
> -     \n\   $ sudo locale-gen en_US.UTF-8"
> +     python3-subunit zstd liblz4-tool file locales libacl1"
>  FEDORA_HOST_PACKAGES_ESSENTIAL : "gawk make wget tar bzip2 gzip python3 unzip perl patch \
>       diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath \
>       ccache perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue perl-bignum socat \
> diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
> index 0fc92550a..f53b9fdbd 100644
> --- a/documentation/ref-manual/system-requirements.rst
> +++ b/documentation/ref-manual/system-requirements.rst
> @@ -152,8 +152,22 @@ with a supported Ubuntu or Debian Linux distribution::
>  
>     $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL;
>  
> +You also need to ensure you have the ``en_US.UTF-8`` locale enabled::
> +
> +   $ locale --all-locales | grep en_US.utf8
> +
> +If this is not the case, you can reconfigure the ``locales`` package to add it (interactive mode only)::

s/interactive mode only/requires an interactive shell/?

Nitpick, but our documentation/standards.md file recommends a line length of 80
characters, we try to stick to it. Could you format the lines to this length,
please?

> +
> +   $ sudo dpkg-reconfigure locales
> +
>  .. note::
>  
> +   -  If your are not using the interactive mode, ``dpkg-reconfigure`` will not work as expected. To add the locale

s/your/you/
s/are not using the interactive mode/are not in an interactive shell/?

> +      you will need to edit ``/etc/locale.gen`` file to add/uncomment the ``en_US.UTF-8`` locale. A naive way to do this as root is::
> +
> +         $ echo "en_US.UTF-8 UTF-8" >> /etc/locale.gen
> +         $ locale-gen
> +
>     -  If your build system has the ``oss4-dev`` package installed, you
>        might experience QEMU build failures due to the package installing
>        its own custom ``/usr/include/linux/soundcard.h`` on the Debian

Thanks,
Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com