Skip to contentSkip to conversation

New LTP documentation!

LTP Andrea Cervesato via ltp 4 participants 14 messages Mar 18, 2024 – Apr 13, 2024

lore
Share & tools
lore
#0 lore raw

Hello everyone,

as already mentioned in the monthly LTP meeting, Linux Test Project lacks of a nice and clean documentation that can be easily accessed by users, developers and maintainers.
The current LTP documentation is also not matching with our expectancy towards the entire project, which is has been heavily refactored and it has changed in the past years, providing a higher quality code and new testing features.

For this reasons, we think it's time to move forward and to start working on documentation, helping people to use, to develop and to maintain LTP in an easier way, increasing quality of the overall project and to call more developers in the community.

I started to work on documentation refactoring, re-organizing the overall structure. The first prototype can be found here:

https://ltp-acerv.readthedocs.io/en/latest/index.html

The idea is to move documents from the current asciidoc format to RST format, following the current kernel docs guide lines [1], and to move API headers descriptions from regular C comments to Doxygen format. By using the powerful readthedocs service [2], it's possible to deploy a documentation website with one simple setup, using Sphinx [3] as the main documentation framework.

For now, website prototype is showing a couple of pages, but the overall structure is there and ready to be filled.

The purpose of this email is to ask for feedback and ideas from the LTP community, so we can make documentation even better. Let me know what you think.

Have a good day,
Andrea Cervesato

[1] https://docs.kernel.org/doc-guide/sphinx.html#writing-documentation
[2] https://about.readthedocs.com/?ref=readthedocs.com
[3] https://www.sphinx-doc.org/en/master

Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
#1 lore raw

Hi Andrea, all,

First, thank you for doing this POC.

Quoted 5 lines

Hello everyone,

as already mentioned in the monthly LTP meeting, Linux Test Project lacks of a nice and clean documentation that can be easily accessed by users, developers and maintainers.

This was from the start confusing for me, because we have docs in wiki and metadata documentation. But the text below explains the main advantage :).

Quoted 10 lines

The current LTP documentation is also not matching with our expectancy towards the entire project, which is has been heavily refactored and it has changed in the past years, providing a higher quality code and new testing features.

For this reasons, we think it's time to move forward and to start working on documentation, helping people to use, to develop and to maintain LTP in an easier way, increasing quality of the overall project and to call more developers in the community.

Quoted 4 lines

I started to work on documentation refactoring, re-organizing the overall structure. The first prototype can be found here:

https://ltp-acerv.readthedocs.io/en/latest/index.html

+1, nice POC. I see from your github LTP fork it's generated via .readthedocs.yml - +1 for docs sources staying in LTP main repository and generated as a result of simple push.

I wonder what to make with our static page:

https://linux-test-project.github.io/

Could we somehow redirect it to our github URL or to docs on readthedocs.io?

Quoted 3 lines

The idea is to move documents from the current asciidoc format to RST format, following the current kernel docs guide lines [1], and to move API headers descriptions from regular C comments to Doxygen format.

IMHO library docs generated with Doxygen is IMHO the main advantage.

Quoted 3 lines

By using the powerful readthedocs service [2], it's possible to deploy a documentation website with one simple setup, using Sphinx [3] as the main documentation framework.

Maybe, we could later generate our metadata docs with Sphinx. To have single source

Although markdown is supported elsewhere (if we one day want to migrate e.g. to gitlab), using readthedocs.

Quoted 6 lines

For now, website prototype is showing a couple of pages, but the overall structure is there and ready to be filled.

The purpose of this email is to ask for feedback and ideas from the LTP community, so we can make documentation even better. Let me know what you think.

+1

I hope you plan to do the conversion and plan in the future to add Doxygen generated docs (to actually add more content than what we have now with github wiki).

Kind regards,
Petr

Quoted 7 lines

Have a good day,
Andrea Cervesato

[1] https://docs.kernel.org/doc-guide/sphinx.html#writing-documentation
[2] https://about.readthedocs.com/?ref=readthedocs.com
[3] https://www.sphinx-doc.org/en/master

Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
#2 lore raw

Hi Petr,

Quoted 26 lines · Petr Vorel

Hi Andrea, all,

First, thank you for doing this POC.

Quoted 4 lines

Hello everyone,
as already mentioned in the monthly LTP meeting, Linux Test Project lacks of a nice and clean documentation that can be easily accessed by users, developers and maintainers.

This was from the start confusing for me, because we have docs in wiki and metadata documentation. But the text below explains the main advantage :).

Quoted 11 lines

The current LTP documentation is also not matching with our expectancy towards the entire project, which is has been heavily refactored and it has changed in the past years, providing a higher quality code and new testing features.
For this reasons, we think it's time to move forward and to start working on documentation, helping people to use, to develop and to maintain LTP in an easier way, increasing quality of the overall project and to call more developers in the community.
I started to work on documentation refactoring, re-organizing the overall structure. The first prototype can be found here:
https://ltp-acerv.readthedocs.io/en/latest/index.html

+1, nice POC. I see from your github LTP fork it's generated via .readthedocs.yml - +1 for docs sources staying in LTP main repository and generated as a result of simple push.

Quoted 5 lines

I wonder what to make with our static page:

https://linux-test-project.github.io/

Could we somehow redirect it to our github URL or to docs on readthedocs.io?

I don't think it's possible. One it's meant to be github pages while readthedocs is hosted somewhere else in https://readthedocs.org/

Quoted 5 lines
Quoted 3 lines

The idea is to move documents from the current asciidoc format to RST format, following the current kernel docs guide lines [1], and to move API headers descriptions from regular C comments to Doxygen format.

IMHO library docs generated with Doxygen is IMHO the main advantage.

Quoted 8 lines
Quoted 3 lines

By using the powerful readthedocs service [2], it's possible to deploy a documentation website with one simple setup, using Sphinx [3] as the main documentation framework.

Maybe, we could later generate our metadata docs with Sphinx. To have single source

Although markdown is supported elsewhere (if we one day want to migrate e.g. to gitlab), using readthedocs.

As far as I know, both github and gitlab support RST and the idea is to rewrite README as well, because it contains multiple errors and it will be replaced by index.rst

Quoted 10 lines
Quoted 5 lines

For now, website prototype is showing a couple of pages, but the overall structure is there and ready to be filled.
The purpose of this email is to ask for feedback and ideas from the LTP community, so we can make documentation even better. Let me know what you think.

+1

I hope you plan to do the conversion and plan in the future to add Doxygen generated docs (to actually add more content than what we have now with github wiki).

Yes, we will use Doxygen. It will come in a second phase, after refactoring the whole documentation into RST.

Quoted 10 lines

Kind regards,
Petr

Quoted 6 lines

Have a good day,
Andrea Cervesato

[1] https://docs.kernel.org/doc-guide/sphinx.html#writing-documentation
[2] https://about.readthedocs.com/?ref=readthedocs.com
[3] https://www.sphinx-doc.org/en/master

I also forgot to mention that Sphinx is highly customizable due to the python scripting, so we can generate static pages at build time, introducing (for example) versions release letters and many other things.

Best regards,
Andrea

Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
#3 lore raw
In reply to Andrea Cervesato via ltp

Hi!

Quoted 4 lines

I started to work on documentation refactoring, re-organizing the overall structure. The first prototype can be found here:

https://ltp-acerv.readthedocs.io/en/latest/index.html

Thanks for doing this! This looks way better than the current wiki we have.

I'm also looking forward to the API documentation parsed from the library headers.

A few minor comments:

"Install and run" -> "Installation and test execution"

"Patch reviewing" -> "Patch review"

"Debugging with gdb and strace" -> Just change that to "Debugging"

And we should mention the newly introduced -D test parameter in that section as well.

Signature · 5 lines
Cyril Hrubis
[email protected]

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#4 lore raw
In reply to Andrea Cervesato via ltp

Hi Andrea,

Quoted 15 lines · Andrea Cervesato via ltp

Hello everyone,

as already mentioned in the monthly LTP meeting, Linux Test Project lacks of a nice and clean documentation that can be easily accessed by users, developers and maintainers.
The current LTP documentation is also not matching with our expectancy towards the entire project, which is has been heavily refactored and it has changed in the past years, providing a higher quality code and new testing features.

For this reasons, we think it's time to move forward and to start working on documentation, helping people to use, to develop and to maintain LTP in an easier way, increasing quality of the overall project and to call more developers in the community.

Quoted 4 lines

I started to work on documentation refactoring, re-organizing the overall structure. The first prototype can be found here:

https://ltp-acerv.readthedocs.io/en/latest/index.html

Looks great! Thanks for bringing this.

And I just tried that the latest LTP compiled & executed succeed on RHEL-7.9.
Can you update the "Oldest tested distributions" [1] part by adding:

RHEL-7.9 Maipo (Distro) 3.10 (kernel) 4.8.5(gcc) 2.17(glibc) -(clang)

[1] https://ltp-acerv.readthedocs.io/en/latest/users/supported_systems.html

Signature · 5 lines
Regards,
Li Wang

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#5 lore raw

Hi!

Quoted 5 lines

And I just tried that the latest LTP compiled & executed succeed on RHEL-7.9.
Can you update the "Oldest tested distributions" [1] part by adding:

RHEL-7.9 Maipo (Distro) 3.10 (kernel) 4.8.5(gcc) 2.17(glibc) -(clang)

Sure we can add this, however you will be responsible for making sure it works and at least do pre-release testing.

Signature · 5 lines
Cyril Hrubis
[email protected]

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#6 lore raw
Quoted 11 lines · Cyril Hrubis

Hi!

Quoted 5 lines

And I just tried that the latest LTP compiled & executed succeed on RHEL-7.9.
Can you update the "Oldest tested distributions" [1] part by adding:

RHEL-7.9 Maipo (Distro) 3.10 (kernel) 4.8.5(gcc) 2.17(glibc)

-(clang)

Sure we can add this, however you will be responsible for making sure it works and at least do pre-release testing.

Yes, of course. Thanks for reminding me.

Signature · 5 lines
Regards,
Li Wang

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#7 lore raw

Hi Li,

Quoted 17 lines · Li Wang

On Tue, Mar 19, 2024 at 10:41 PM Cyril Hrubis <[email protected]> wrote:

    Hi!
    > And I just tried that the latest LTP compiled & executed succeed on
    > RHEL-7.9.
    > Can you update the "Oldest tested distributions" [1] part by adding:
    >
    >   RHEL-7.9 Maipo (Distro)  3.10 (kernel)  4.8.5(gcc)
    2.17(glibc)  -(clang)

    Sure we can add this, however you will be responsible for making
    sure it
    works and at least do pre-release testing.
Quoted 2 lines

Yes, of course. Thanks for reminding me.

If it's Ok for you, I will add RHEL to the "Oldest tested distribution" chapter as suggested.

Quoted 4 lines
Signature · 3 lines
-- 
Regards,
Li Wang

Andrea

Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
#8 lore raw
Quoted 16 lines · Andrea Cervesato

Hi Li,

On 3/20/24 03:52, Li Wang wrote:

Quoted 8 lines · Cyril Hrubis

Hi!

Quoted 5 lines

And I just tried that the latest LTP compiled & executed succeed on RHEL-7.9.
Can you update the "Oldest tested distributions" [1] part by adding:

RHEL-7.9 Maipo (Distro) 3.10 (kernel) 4.8.5(gcc) 2.17(glibc)

-(clang)

Quoted 9 lines
Quoted 3 lines

Sure we can add this, however you will be responsible for making sure it works and at least do pre-release testing.

Yes, of course. Thanks for reminding me.

If it's Ok for you, I will add RHEL to the "Oldest tested distribution" chapter as suggested.

Yes, please. I do that pre-release testing for each season.

Thank you~

Signature · 5 lines
Regards,
Li Wang

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#9 lore raw
In reply to Li Wang

Hi all,

Quoted 26 lines

Hi Andrea,

Quoted 15 lines · Andrea Cervesato via ltp

Hello everyone,

as already mentioned in the monthly LTP meeting, Linux Test Project lacks of a nice and clean documentation that can be easily accessed by users, developers and maintainers.
The current LTP documentation is also not matching with our expectancy towards the entire project, which is has been heavily refactored and it has changed in the past years, providing a higher quality code and new testing features.

For this reasons, we think it's time to move forward and to start working on documentation, helping people to use, to develop and to maintain LTP in an easier way, increasing quality of the overall project and to call more developers in the community.

Quoted 4 lines

I started to work on documentation refactoring, re-organizing the overall structure. The first prototype can be found here:

https://ltp-acerv.readthedocs.io/en/latest/index.html

Quoted 7 lines

Looks great! Thanks for bringing this.

And I just tried that the latest LTP compiled & executed succeed on RHEL-7.9.
Can you update the "Oldest tested distributions" [1] part by adding:

RHEL-7.9 Maipo (Distro) 3.10 (kernel) 4.8.5(gcc) 2.17(glibc) -(clang)

Although in the original docs, the table was not under section "Build testing with GitHub Actions", I assumed it's clear we talk about GitHub Actions testing. That's why I put there only distros we actually have in .github/workflows/ci.yml and not e.g. SLE12-SP2 which we test with latest LTP release.

I actually find useful to stand which distros we test privately, but this info should be obvious (either add a column "CI", where would be "GitHub Actions" or "RHEL private CI" or whatever.

@Li Andrea put there as new info: "Minimal supported kernel version is 3.10." which is not in old docs. Do you really test RHEL-7.9 (3.10 based) with the latest LTP release?

@Yang Xu I found you removed fallbacks up to kernel 3.10:

06ada0329 ("Remove old kernel version check when using min_kver under 3.10") 862d94c45 ("Remove old kernel version check when using tst_kvercmp under 3.10") 971828c00 ("shell: Remove old kernel version check below 3.10")

Hopefully I haven't overlook anything.

@Andrea: Also, I would prefer to put back paragraph "1. Build testing with GitHub Actions". I'll send a patch, to force myself to learn building new docs.

Kind regards,
Petr

Quoted 1 line

[1] https://ltp-acerv.readthedocs.io/en/latest/users/supported_systems.html

Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
#10 lore raw

Hi Petr,

Quoted 56 lines · Petr Vorel

Hi all,

Quoted 3 lines

Hi Andrea,

On Mon, Mar 18, 2024 at 8:41 PM Andrea Cervesato via ltp <

[email protected]>

Quoted 12 lines
Quoted 9 lines · wrote:

Hello everyone,

as already mentioned in the monthly LTP meeting, Linux Test Project lacks of a nice and clean documentation that can be easily accessed by users, developers and maintainers.
The current LTP documentation is also not matching with our expectancy towards the entire project, which is has been heavily refactored and it has changed in the past years, providing a higher quality code and new testing features.

Quoted 3 lines
Quoted 3 lines

For this reasons, we think it's time to move forward and to start working on documentation, helping people to use, to develop and to maintain LTP in an easier way, increasing quality of the overall

project

Quoted 8 lines
Quoted 6 lines

and to call more developers in the community.

I started to work on documentation refactoring, re-organizing the overall structure. The first prototype can be found here:

https://ltp-acerv.readthedocs.io/en/latest/index.html

Quoted 7 lines

Looks great! Thanks for bringing this.

And I just tried that the latest LTP compiled & executed succeed on RHEL-7.9.
Can you update the "Oldest tested distributions" [1] part by adding:

RHEL-7.9 Maipo (Distro) 3.10 (kernel) 4.8.5(gcc) 2.17(glibc)

-(clang)

Although in the original docs, the table was not under section "Build testing
with GitHub Actions", I assumed it's clear we talk about GitHub Actions testing.
That's why I put there only distros we actually have in .github/workflows/ci.yml
and not e.g. SLE12-SP2 which we test with latest LTP release.

I actually find useful to stand which distros we test privately, but this info
should be obvious (either add a column "CI", where would be "GitHub Actions" or
"RHEL private CI" or whatever.

Quoted 5 lines

@Li Andrea put there as new info: "Minimal supported kernel version is 3.10."
which is not in old docs. Do you really test RHEL-7.9 (3.10 based) with the latest LTP release?

Yes, I did but only checked on RHEL-7.9 with x86_64 and s390x (compile & execution well) last time.

After rebuilding the latest branch on all arches, I found the rest arches have
problems in compiling (forgive me careless last time).

Now I am hesitant to fix the error or raise the baseline to RHEL8.3. (I talked to colleagues and got to know they always chose to use fixed versions of LTP when <=RHEL8.2).

---------------------
# 3.10.0-1136.el7.ppc64le

# glibc-2.17-316.el7.ppc64le

In file included from /usr/include/termios.h:40:0,

                 from /usr/include/bits/ioctl-types.h:5,
                 from /usr/include/sys/ioctl.h:29,
                 from ../../../../include/lapi/ioctl.h:11,
                 from ioctl02.c:31:
/usr/include/bits/termios.h:33:8: error: redefinition of ‘struct termios’
 struct termios {
        ^
In file included from ioctl02.c:29:0:
/usr/include/asm/termbits.h:22:8: note: originally defined here
 struct termios {
        ^
Quoted 22 lines

@Yang Xu I found you removed fallbacks up to kernel 3.10:

06ada0329 ("Remove old kernel version check when using min_kver under 3.10")
862d94c45 ("Remove old kernel version check when using tst_kvercmp under 3.10")
971828c00 ("shell: Remove old kernel version check below 3.10")

Hopefully I haven't overlook anything.

@Andrea: Also, I would prefer to put back paragraph "1. Build testing with GitHub Actions". I'll send a patch, to force myself to learn building new docs.

Kind regards,
Petr

Quoted 1 line

[1]

https://ltp-acerv.readthedocs.io/en/latest/users/supported_systems.html

Signature · 5 lines
Regards,
Li Wang

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#11 lore raw

Hi Li,

Quoted 69 lines

Hi Petr,

Quoted 56 lines · Petr Vorel

Hi all,

Quoted 3 lines

Hi Andrea,

On Mon, Mar 18, 2024 at 8:41 PM Andrea Cervesato via ltp <

[email protected]>

Quoted 12 lines
Quoted 9 lines · wrote:

Hello everyone,

as already mentioned in the monthly LTP meeting, Linux Test Project lacks of a nice and clean documentation that can be easily accessed by users, developers and maintainers.
The current LTP documentation is also not matching with our expectancy towards the entire project, which is has been heavily refactored and it has changed in the past years, providing a higher quality code and new testing features.

Quoted 3 lines
Quoted 3 lines

For this reasons, we think it's time to move forward and to start working on documentation, helping people to use, to develop and to maintain LTP in an easier way, increasing quality of the overall

project

Quoted 8 lines
Quoted 6 lines

and to call more developers in the community.

I started to work on documentation refactoring, re-organizing the overall structure. The first prototype can be found here:

https://ltp-acerv.readthedocs.io/en/latest/index.html

Quoted 7 lines

Looks great! Thanks for bringing this.

And I just tried that the latest LTP compiled & executed succeed on RHEL-7.9.
Can you update the "Oldest tested distributions" [1] part by adding:

RHEL-7.9 Maipo (Distro) 3.10 (kernel) 4.8.5(gcc) 2.17(glibc)

-(clang)

Although in the original docs, the table was not under section "Build testing
with GitHub Actions", I assumed it's clear we talk about GitHub Actions testing.
That's why I put there only distros we actually have in .github/workflows/ci.yml
and not e.g. SLE12-SP2 which we test with latest LTP release.

I actually find useful to stand which distros we test privately, but this info
should be obvious (either add a column "CI", where would be "GitHub Actions" or
"RHEL private CI" or whatever.

Quoted 4 lines

@Li Andrea put there as new info: "Minimal supported kernel version is 3.10."
which is not in old docs. Do you really test RHEL-7.9 (3.10 based) with the latest LTP release?

Yes, I did but only checked on RHEL-7.9 with x86_64 and s390x (compile & execution well) last time.

Quoted 7 lines

After rebuilding the latest branch on all arches, I found the rest arches have
problems in compiling (forgive me careless last time).

Now I am hesitant to fix the error or raise the baseline to RHEL8.3. (I talked to colleagues and got to know they always chose to use fixed versions of LTP when <=RHEL8.2).

Thanks for info! Even you fix the compilation outdated info is why I would delete RHEL 7.9 info and 3.10 based kernel from our docs. Currently I'm not fixing test runtime issues even for SLE12-SP3 (kernel 4.4 based). Having "we support kernel 3.10" is asking for random testing folks creating useless github issues "test broken on kernel >= 3.10 < 4.19 (oldest mainline longterm kernel).

I would really state what we test in CI and did not give false expectation about the actual test functionality. And if we really want to state what we build for, I'd prefer mentioning that we are compile for that distro (i.e. tests still can have bugs, it might be skipped due old config and bug not notice or test failure but WONTFIX etc). Again, missed update when we change GitHub Actions setup is easily to be checked, but claiming something is testing private CI is asking to have outdated info sooner or later.

Kind regards,
Petr

Quoted 6 lines

---------------------
# 3.10.0-1136.el7.ppc64le

# glibc-2.17-316.el7.ppc64le

In file included from /usr/include/termios.h:40:0,

Quoted 11 lines
                 from /usr/include/bits/ioctl-types.h:5,
                 from /usr/include/sys/ioctl.h:29,
                 from ../../../../include/lapi/ioctl.h:11,
                 from ioctl02.c:31:
/usr/include/bits/termios.h:33:8: error: redefinition of ‘struct termios’
 struct termios {
        ^
In file included from ioctl02.c:29:0:
/usr/include/asm/termbits.h:22:8: note: originally defined here
 struct termios {
        ^

Hm, not in https://sourceware.org/glibc/wiki/Synchronizing_Headers.

I suspect:
697a06a82 ("ioctl02: Use correct termios structure")

That was required to fix runtime error on ppc64le, not sure if it's easy to be fixed (m4 macro would be probably required).

If not, feel free to bisect, whether one of these or something else broke it:

8878fc683 ("ioctl,pty: Add fallback definition of struct termio") fed63ce97 ("pty03: Add fallback definition for TIOCVHANGUP")

Kind regards,
Petr

Quoted 19 lines
Quoted 19 lines

@Yang Xu I found you removed fallbacks up to kernel 3.10:

06ada0329 ("Remove old kernel version check when using min_kver under 3.10")
862d94c45 ("Remove old kernel version check when using tst_kvercmp under 3.10")
971828c00 ("shell: Remove old kernel version check below 3.10")

Hopefully I haven't overlook anything.

@Andrea: Also, I would prefer to put back paragraph "1. Build testing with GitHub Actions". I'll send a patch, to force myself to learn building new docs.

Kind regards,
Petr

Quoted 1 line

[1]

https://ltp-acerv.readthedocs.io/en/latest/users/supported_systems.html

Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
#12 lore raw
Quoted 85 lines · Petr Vorel

Hi Li,

Quoted 16 lines

Hi Petr,

Quoted 12 lines · Petr Vorel

Hi all,

Quoted 3 lines

Hi Andrea,

On Mon, Mar 18, 2024 at 8:41 PM Andrea Cervesato via ltp <

[email protected]>

Quoted 6 lines
Quoted 4 lines · wrote:

Hello everyone,

as already mentioned in the monthly LTP meeting, Linux Test Project lacks of a nice and clean documentation that can be easily

accessed by

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

users, developers and maintainers.
The current LTP documentation is also not matching with our

expectancy

Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line

towards the entire project, which is has been heavily refactored

and it

Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line

has changed in the past years, providing a higher quality code and

new

Quoted 31 lines
Quoted 30 lines
Quoted 5 lines
Quoted 5 lines

testing features.

For this reasons, we think it's time to move forward and to start working on documentation, helping people to use, to develop and to maintain LTP in an easier way, increasing quality of the overall

project

Quoted 8 lines
Quoted 6 lines

and to call more developers in the community.

I started to work on documentation refactoring, re-organizing the overall structure. The first prototype can be found here:

https://ltp-acerv.readthedocs.io/en/latest/index.html

Quoted 7 lines

Looks great! Thanks for bringing this.

And I just tried that the latest LTP compiled & executed succeed on RHEL-7.9.
Can you update the "Oldest tested distributions" [1] part by adding:

RHEL-7.9 Maipo (Distro) 3.10 (kernel) 4.8.5(gcc) 2.17(glibc)

-(clang)

Although in the original docs, the table was not under section "Build testing
with GitHub Actions", I assumed it's clear we talk about GitHub Actions testing.
That's why I put there only distros we actually have in .github/workflows/ci.yml
and not e.g. SLE12-SP2 which we test with latest LTP release.

Quoted 1 line
Quoted 1 line

I actually find useful to stand which distros we test privately, but

this

Quoted 11 lines
Quoted 11 lines

info
should be obvious (either add a column "CI", where would be "GitHub Actions" or
"RHEL private CI" or whatever.

@Li Andrea put there as new info: "Minimal supported kernel version is 3.10."
which is not in old docs. Do you really test RHEL-7.9 (3.10 based)

with the

Quoted 6 lines
Quoted 1 line

latest LTP release?

Yes, I did but only checked on RHEL-7.9 with x86_64 and s390x (compile & execution well) last time.

Quoted 7 lines

After rebuilding the latest branch on all arches, I found the rest arches have
problems in compiling (forgive me careless last time).

Now I am hesitant to fix the error or raise the baseline to RHEL8.3. (I talked to colleagues and got to know they always chose to use fixed versions of LTP when <=RHEL8.2).

Quoted 9 lines

Thanks for info! Even you fix the compilation outdated info is why I would delete RHEL 7.9 info and 3.10 based kernel from our docs. Currently I'm not fixing test runtime issues even for SLE12-SP3 (kernel 4.4 based). Having "we
support kernel 3.10" is asking for random testing folks creating useless github
issues "test broken on kernel >= 3.10 < 4.19 (oldest mainline longterm kernel).

Yes, Make sense!

Please feel free to delete that line about RHEL7.9, we shouldn't leave holes open to risk between kernel 3.10 and 4.19 versions.

(or at least bump up the support to kernel-4.18 (rhel8), but consider the CI only tests on fedora and Centos-stream9, so let's give up it)

Quoted 15 lines

I would really state what we test in CI and did not give false expectation about
the actual test functionality. And if we really want to state what we build for,
I'd prefer mentioning that we are compile for that distro (i.e. tests still can
have bugs, it might be skipped due old config and bug not notice or test failure
but WONTFIX etc). Again, missed update when we change GitHub Actions setup is
easily to be checked, but claiming something is testing private CI is asking to
have outdated info sooner or later.

+1

Let's align the maintenance version (In Doc) with GitHub Actions.

Quoted 32 lines

Kind regards,
Petr

Quoted 6 lines

---------------------
# 3.10.0-1136.el7.ppc64le

# glibc-2.17-316.el7.ppc64le

In file included from /usr/include/termios.h:40:0,

Quoted 11 lines
                 from /usr/include/bits/ioctl-types.h:5,
                 from /usr/include/sys/ioctl.h:29,
                 from ../../../../include/lapi/ioctl.h:11,
                 from ioctl02.c:31:
/usr/include/bits/termios.h:33:8: error: redefinition of ‘struct termios’
 struct termios {
        ^
In file included from ioctl02.c:29:0:
/usr/include/asm/termbits.h:22:8: note: originally defined here
 struct termios {
        ^

Hm, not in https://sourceware.org/glibc/wiki/Synchronizing_Headers.

I suspect:
697a06a82 ("ioctl02: Use correct termios structure")

That was required to fix runtime error on ppc64le, not sure if it's easy to be
fixed (m4 macro would be probably required).

Quoted 6 lines

If not, feel free to bisect, whether one of these or something else broke it:

8878fc683 ("ioctl,pty: Add fallback definition of struct termio") fed63ce97 ("pty03: Add fallback definition for TIOCVHANGUP")

Thanks, I wouldn't send a patch to fix it, to avoid compilation complications.
Let's look ahead :).

We suggest people pick up fixed version ltp-20210927[1] for older RHEL7 testing if people ask.

[1] This version has stood the test of time internally for the RHEL7 series.

Signature · 5 lines
Regards,
Li Wang

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#13 lore raw
In reply to Li Wang

Hi,

Quoted 108 lines · Li Wang

Hi Petr,

On Wed, Apr 10, 2024 at 6:12 PM Petr Vorel <[email protected]> wrote:

Hi all,

> Hi Andrea,

> On Mon, Mar 18, 2024 at 8:41 PM Andrea Cervesato via ltp <[email protected]>
> wrote:

> > Hello everyone,

> > as already mentioned in the monthly LTP meeting, Linux Test Project
> > lacks of a nice and clean documentation that can be easily accessed by
> > users, developers and maintainers.
> > The current LTP documentation is also not matching with our expectancy
> > towards the entire project, which is has been heavily refactored and it
> > has changed in the past years, providing a higher quality code and new
> > testing features.

> > For this reasons, we think it's time to move forward and to start > > working on documentation, helping people to use, to develop and to > > maintain LTP in an easier way, increasing quality of the overall project
> > and to call more developers in the community.

> > I started to work on documentation refactoring, re-organizing the > > overall structure. The first prototype can be found here:

> > https://ltp-acerv.readthedocs.io/en/latest/index.html

> Looks great! Thanks for bringing this.

> And I just tried that the latest LTP compiled & executed succeed on > RHEL-7.9.
> Can you update the "Oldest tested distributions" [1] part by adding:

>   RHEL-7.9 Maipo (Distro)  3.10 (kernel)  4.8.5(gcc) 2.17(glibc)  -(clang)

Although in the original docs, the table was not under section "Build testing
with GitHub Actions", I assumed it's clear we talk about GitHub Actions testing.
That's why I put there only distros we actually have in .github/workflows/ci.yml
and not e.g. SLE12-SP2 which we test with latest LTP release.

I actually find useful to stand which distros we test privately, but this info
should be obvious (either add a column "CI", where would be "GitHub Actions" or
"RHEL private CI" or whatever.

@Li Andrea put there as new info: "Minimal supported kernel version is 3.10."
which is not in old docs. Do you really test RHEL-7.9 (3.10 based) with the
latest LTP release?

Yes, I did but only checked on RHEL-7.9 with x86_64 and s390x (compile & execution well) last time.

After rebuilding the latest branch on all arches, I found the rest arches have problems in compiling (forgive me careless last time).

Now I am hesitant to fix the error or raise the baseline to RHEL8.3.
(I talked to colleagues and got to know they always chose to use fixed versions of LTP when <=RHEL8.2).

---------------------
# 3.10.0-1136.el7.ppc64le

# glibc-2.17-316.el7.ppc64le

In file included from /usr/include/termios.h:40:0,

                  from /usr/include/bits/ioctl-types.h:5,
                  from /usr/include/sys/ioctl.h:29,
                  from ../../../../include/lapi/ioctl.h:11,
                  from ioctl02.c:31:
/usr/include/bits/termios.h:33:8: error: redefinition of ‘struct termios’
  struct termios {
         ^

In file included from ioctl02.c:29:0:
/usr/include/asm/termbits.h:22:8: note: originally defined here
struct termios {
^

@Yang Xu I found you removed fallbacks up to kernel 3.10:

06ada0329 ("Remove old kernel version check when using min_kver under 3.10")
862d94c45 ("Remove old kernel version check when using tst_kvercmp under 3.10")
971828c00 ("shell: Remove old kernel version check below 3.10")

Quoted 7 lines

Hopefully I haven't overlook anything.

@Andrea: Also, I would prefer to put back paragraph "1. Build testing with
GitHub Actions". I'll send a patch, to force myself to learn building new docs.

Feel free, I think it's a good idea. At the moment there's just a short comment about Github actions here:

https://linux-test-project.readthedocs.io/en/latest/developers/writing_tests.html#testing-builds-with-github-actions

Quoted 12 lines
    Kind regards,
    Petr

    > [1]
    https://ltp-acerv.readthedocs.io/en/latest/users/supported_systems.html
Signature · 2 lines
Regards,
Li Wang
Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp