[2/3] doc: Clarify that the only public CI testing is build only

Also convert .github/workflows/ci.yml as link to github
(unfortunately that remove code formatting).

Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
 doc/developers/writing_tests.rst | 4 ++--
 doc/users/supported_systems.rst  | 9 +++++++++
 2 files changed, 11 insertions(+), 2 deletions(-)

Hi!

On 4/19/24 14:42, Petr Vorel wrote:
> Also convert .github/workflows/ci.yml as link to github
> (unfortunately that remove code formatting).
>
> Signed-off-by: Petr Vorel <pvorel@suse.cz>
> ---
>   doc/developers/writing_tests.rst | 4 ++--
>   doc/users/supported_systems.rst  | 9 +++++++++
>   2 files changed, 11 insertions(+), 2 deletions(-)
>
> diff --git a/doc/developers/writing_tests.rst b/doc/developers/writing_tests.rst
> index 032fbcbd5..3db56a558 100644
> --- a/doc/developers/writing_tests.rst
> +++ b/doc/developers/writing_tests.rst
> @@ -346,8 +346,8 @@ Testing builds with GitHub Actions
>   Master branch is tested in `GitHub Actions <https://github.com/linux-test-project/ltp/actions>`_
>   to ensure LTP builds in various distributions, including old, current and
>   bleeding edge. ``gcc`` and ``clang`` toolchains are also tested for various
> -architectures using cross-compilation. For a full list of tested distros, please
> -check ``.github/workflows/ci.yml``.
> +architectures using cross-compilation. For a full list of tested distros, please check
> +`.github/workflows/ci.yml <https://github.com/linux-test-project/ltp/blob/master/.github/workflows/ci.yml>`_.
Maybe we can store github link into a variable and use it around the 
documentation.
I'm not sure if it works, but eventually take a look at: 
https://groups.google.com/g/sphinx-users/c/OitnjX8SIA4/m/7_kUL0TaCwAJ
>   
>   .. note::
>   
> diff --git a/doc/users/supported_systems.rst b/doc/users/supported_systems.rst
> index 82774c2ef..a9086f4d8 100644
> --- a/doc/users/supported_systems.rst
> +++ b/doc/users/supported_systems.rst
> @@ -3,6 +3,12 @@
>   Supported systems
>   =================
>   
> +Build testing is done with `GitHub Actions <https://github.com/linux-test-project/ltp/actions>`_.
> +
> +.. note::
> +
> +      There is no CI testing of the actual tests run.
> +
>   Kernel version
>   --------------
>   
> @@ -38,6 +44,9 @@ Oldest tested distributions
>         - 10.2.1
>         - 11.0.1
>   
> +For a full list of tested distros, please tested distros, please check
> +`.github/workflows/ci.yml <https://github.com/linux-test-project/ltp/blob/master/.github/workflows/ci.yml>`_.
> +
>   Older distributions are not officially supported, which means that it
>   may or may not work. It all depends on your luck. It should be possible
>   to compile latest LTP even on slightly older distributions than we

Andrea

Hi Andrea,

> > +++ b/doc/developers/writing_tests.rst
> > @@ -346,8 +346,8 @@ Testing builds with GitHub Actions
> >   Master branch is tested in `GitHub Actions <https://github.com/linux-test-project/ltp/actions>`_
> >   to ensure LTP builds in various distributions, including old, current and
> >   bleeding edge. ``gcc`` and ``clang`` toolchains are also tested for various
> > -architectures using cross-compilation. For a full list of tested distros, please
> > -check ``.github/workflows/ci.yml``.
> > +architectures using cross-compilation. For a full list of tested distros, please check
> > +`.github/workflows/ci.yml <https://github.com/linux-test-project/ltp/blob/master/.github/workflows/ci.yml>`_.
> Maybe we can store github link into a variable and use it around the
> documentation.
> I'm not sure if it works, but eventually take a look at:
> https://groups.google.com/g/sphinx-users/c/OitnjX8SIA4/m/7_kUL0TaCwAJ

Thanks for a tip. Well, I don't think it's not working, but maybe I'm wrong.

I tested it with following diff inspired by docs [1], but the text in the link
is: "issue `123`" instead of 123 being formatted as code. Maybe there is some
parameter which can be tweaked or we need find another extension or write patch
for sphinx.ext.extlinks.

Looking at sphinx_version_ref [2] it also uses `, thus it will likely not work
either.

Anyway, it's not important we just loose some formatting. It's sort of "nice to
have".

Kind regards,
Petr

[1] https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html
[2] https://sphinx-version-ref.readthedocs.io/en/stable/


diff --git doc/conf.py doc/conf.py
index fb3e83cf2..771efbb34 100644
--- doc/conf.py
+++ doc/conf.py
@@ -22,9 +22,13 @@ release = '1.0'
 
 extensions = [
     'linuxdoc.rstKernelDoc',
-    'sphinxcontrib.spelling'
+    'sphinxcontrib.spelling',
+    'sphinx.ext.extlinks'
 ]
 
+extlinks = {'issue': ('https://github.com/sphinx-doc/sphinx/issues/%s',
+                      'issue `%s`')}
+
 exclude_patterns = ["html*", '_static*']
 
 spelling_lang = "en_US"
diff --git doc/developers/documentation.rst doc/developers/documentation.rst
index 825495c50..73b76dcde 100644
--- doc/developers/documentation.rst
+++ doc/developers/documentation.rst
@@ -3,6 +3,8 @@
 Documentation
 =============
 
+:issue:`123`
+
 This section explains how to use and develop the LTP documentation. The current
 documentation format is written using
 `reStructedText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_


> >   .. note::
> > diff --git a/doc/users/supported_systems.rst b/doc/users/supported_systems.rst
> > index 82774c2ef..a9086f4d8 100644
> > --- a/doc/users/supported_systems.rst
> > +++ b/doc/users/supported_systems.rst
> > @@ -3,6 +3,12 @@
> >   Supported systems
> >   =================
> > +Build testing is done with `GitHub Actions <https://github.com/linux-test-project/ltp/actions>`_.
> > +
> > +.. note::
> > +
> > +      There is no CI testing of the actual tests run.
> > +
> >   Kernel version
> >   --------------
> > @@ -38,6 +44,9 @@ Oldest tested distributions
> >         - 10.2.1
> >         - 11.0.1
> > +For a full list of tested distros, please tested distros, please check
> > +`.github/workflows/ci.yml <https://github.com/linux-test-project/ltp/blob/master/.github/workflows/ci.yml>`_.
> > +
> >   Older distributions are not officially supported, which means that it
> >   may or may not work. It all depends on your luck. It should be possible
> >   to compile latest LTP even on slightly older distributions than we

> Andrea

Hi!
> Also convert .github/workflows/ci.yml as link to github
> (unfortunately that remove code formatting).
> 
> Signed-off-by: Petr Vorel <pvorel@suse.cz>
> ---
>  doc/developers/writing_tests.rst | 4 ++--
>  doc/users/supported_systems.rst  | 9 +++++++++
>  2 files changed, 11 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/developers/writing_tests.rst b/doc/developers/writing_tests.rst
> index 032fbcbd5..3db56a558 100644
> --- a/doc/developers/writing_tests.rst
> +++ b/doc/developers/writing_tests.rst
> @@ -346,8 +346,8 @@ Testing builds with GitHub Actions
>  Master branch is tested in `GitHub Actions <https://github.com/linux-test-project/ltp/actions>`_
                   ^
		   build
>  to ensure LTP builds in various distributions, including old, current and
>  bleeding edge. ``gcc`` and ``clang`` toolchains are also tested for various
> -architectures using cross-compilation. For a full list of tested distros, please
> -check ``.github/workflows/ci.yml``.
> +architectures using cross-compilation. For a full list of tested distros, please check
                                                            ^
							    build
> +`.github/workflows/ci.yml <https://github.com/linux-test-project/ltp/blob/master/.github/workflows/ci.yml>`_.
>  
>  .. note::
>  
> diff --git a/doc/users/supported_systems.rst b/doc/users/supported_systems.rst
> index 82774c2ef..a9086f4d8 100644
> --- a/doc/users/supported_systems.rst
> +++ b/doc/users/supported_systems.rst
> @@ -3,6 +3,12 @@
>  Supported systems
>  =================
>  
> +Build testing is done with `GitHub Actions <https://github.com/linux-test-project/ltp/actions>`_.
> +
> +.. note::
> +
> +      There is no CI testing of the actual tests run.

Maybe a bit better "There is no CI for the actual test runs."

>  Kernel version
>  --------------
>  
> @@ -38,6 +44,9 @@ Oldest tested distributions
>        - 10.2.1
>        - 11.0.1
>  
> +For a full list of tested distros, please tested distros, pleae check
                     ^
		     build
> +`.github/workflows/ci.yml <https://github.com/linux-test-project/ltp/blob/master/.github/workflows/ci.yml>`_.
> +
>  Older distributions are not officially supported, which means that it
>  may or may not work. It all depends on your luck. It should be possible
>  to compile latest LTP even on slightly older distributions than we
> -- 
> 2.43.0
>

Hi Cyril,

> Hi!
> > Also convert .github/workflows/ci.yml as link to github
> > (unfortunately that remove code formatting).

> > Signed-off-by: Petr Vorel <pvorel@suse.cz>
> > ---
> >  doc/developers/writing_tests.rst | 4 ++--
> >  doc/users/supported_systems.rst  | 9 +++++++++
> >  2 files changed, 11 insertions(+), 2 deletions(-)

> > diff --git a/doc/developers/writing_tests.rst b/doc/developers/writing_tests.rst
> > index 032fbcbd5..3db56a558 100644
> > --- a/doc/developers/writing_tests.rst
> > +++ b/doc/developers/writing_tests.rst
> > @@ -346,8 +346,8 @@ Testing builds with GitHub Actions
> >  Master branch is tested in `GitHub Actions <https://github.com/linux-test-project/ltp/actions>`_
>                    ^
> 		   build

"build tested" is much better wording, thank you!

> >  to ensure LTP builds in various distributions, including old, current and
> >  bleeding edge. ``gcc`` and ``clang`` toolchains are also tested for various
> > -architectures using cross-compilation. For a full list of tested distros, please
> > -check ``.github/workflows/ci.yml``.
> > +architectures using cross-compilation. For a full list of tested distros, please check
>                                                             ^
> 							    build
> > +`.github/workflows/ci.yml <https://github.com/linux-test-project/ltp/blob/master/.github/workflows/ci.yml>`_.

> >  .. note::

> > diff --git a/doc/users/supported_systems.rst b/doc/users/supported_systems.rst
> > index 82774c2ef..a9086f4d8 100644
> > --- a/doc/users/supported_systems.rst
> > +++ b/doc/users/supported_systems.rst
> > @@ -3,6 +3,12 @@
> >  Supported systems
> >  =================

> > +Build testing is done with `GitHub Actions <https://github.com/linux-test-project/ltp/actions>`_.
> > +
> > +.. note::
> > +
> > +      There is no CI testing of the actual tests run.

> Maybe a bit better "There is no CI for the actual test runs."

+1, again thanks.


> >  Kernel version
> >  --------------

> > @@ -38,6 +44,9 @@ Oldest tested distributions
> >        - 10.2.1
> >        - 11.0.1

> > +For a full list of tested distros, please tested distros, pleae check
>                      ^
> 		     build


Do we want to wait for more people acking it?
Or can I merge it with just your and Li's ack?

Kind regards,
Petr

> > +`.github/workflows/ci.yml <https://github.com/linux-test-project/ltp/blob/master/.github/workflows/ci.yml>`_.
> > +
> >  Older distributions are not officially supported, which means that it
> >  may or may not work. It all depends on your luck. It should be possible
> >  to compile latest LTP even on slightly older distributions than we
> > -- 
> > 2.43.0

Hi all,

merged rebased version of this and previous patch.
Thank you all!

Kind regards,
Petr