[LTP] [RFC PATCH 0/2] Wiki: files rename,add 'Release procedure'

[LTP] [RFC PATCH 0/2] Wiki: files rename,add 'Release procedure'

[Petr Vorel]

Petr Vorel (2):
  doc: Rename files to names from ltp.wiki.git
  doc: Add Release procedure

 .github/workflows/wiki-mirror.yml             | 16 +----
 ...ild-system-guide.txt => Build-System.rest} |  0
 doc/{c-test-api.txt => C-Test-API.asciidoc}   |  0
 ...mple.txt => C-Test-Case-Tutorial.asciidoc} |  0
 ...-c-api.txt => C-Test-Network-API.asciidoc} |  0
 ...kvm-test-api.txt => KVM-Test-API.asciidoc} |  0
 ...P-Library-API-Writing-Guidelines.asciidoc} |  0
 doc/LTP-Release-Procedure.asciidoc            | 67 +++++++++++++++++++
 ...aintainer-Patch-Review-Checklist.asciidoc} |  0
 ...l-test-api.txt => Shell-Test-API.asciidoc} |  0
 ...kernel,-libc,-toolchain-versions.asciidoc} |  0
 ...s.txt => Test-Writing-Guidelines.asciidoc} |  0
 ...ser-guide.txt => User-Guidelines.asciidoc} |  0
 13 files changed, 70 insertions(+), 13 deletions(-)
 rename doc/{build-system-guide.txt => Build-System.rest} (100%)
 rename doc/{c-test-api.txt => C-Test-API.asciidoc} (100%)
 rename doc/{c-test-tutorial-simple.txt => C-Test-Case-Tutorial.asciidoc} (100%)
 rename doc/{network-c-api.txt => C-Test-Network-API.asciidoc} (100%)
 rename doc/{kvm-test-api.txt => KVM-Test-API.asciidoc} (100%)
 rename doc/{library-api-writing-guidelines.txt => LTP-Library-API-Writing-Guidelines.asciidoc} (100%)
 create mode 100644 doc/LTP-Release-Procedure.asciidoc
 rename doc/{maintainer-patch-review-checklist.txt => Maintainer-Patch-Review-Checklist.asciidoc} (100%)
 rename doc/{shell-test-api.txt => Shell-Test-API.asciidoc} (100%)
 rename doc/{supported-kernel-libc-versions.txt => Supported-kernel,-libc,-toolchain-versions.asciidoc} (100%)
 rename doc/{test-writing-guidelines.txt => Test-Writing-Guidelines.asciidoc} (100%)
 rename doc/{user-guide.txt => User-Guidelines.asciidoc} (100%)

-- 
2.40.0


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

[LTP] [RFC PATCH 1/2] doc: Rename files to names from ltp.wiki.git

[Petr Vorel]

Keeping the original extension from LTP wiki git brings:
* add syntax highlight for editors
* no need to add new file (only new extension)

Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
 .github/workflows/wiki-mirror.yml                | 16 +++-------------
 ...{build-system-guide.txt => Build-System.rest} |  0
 doc/{c-test-api.txt => C-Test-API.asciidoc}      |  0
 ...-simple.txt => C-Test-Case-Tutorial.asciidoc} |  0
 ...ork-c-api.txt => C-Test-Network-API.asciidoc} |  0
 doc/{kvm-test-api.txt => KVM-Test-API.asciidoc}  |  0
 ... LTP-Library-API-Writing-Guidelines.asciidoc} |  0
 ...> Maintainer-Patch-Review-Checklist.asciidoc} |  0
 ...hell-test-api.txt => Shell-Test-API.asciidoc} |  0
 ...ed-kernel,-libc,-toolchain-versions.asciidoc} |  0
 ...ines.txt => Test-Writing-Guidelines.asciidoc} |  0
 doc/{user-guide.txt => User-Guidelines.asciidoc} |  0
 12 files changed, 3 insertions(+), 13 deletions(-)
 rename doc/{build-system-guide.txt => Build-System.rest} (100%)
 rename doc/{c-test-api.txt => C-Test-API.asciidoc} (100%)
 rename doc/{c-test-tutorial-simple.txt => C-Test-Case-Tutorial.asciidoc} (100%)
 rename doc/{network-c-api.txt => C-Test-Network-API.asciidoc} (100%)
 rename doc/{kvm-test-api.txt => KVM-Test-API.asciidoc} (100%)
 rename doc/{library-api-writing-guidelines.txt => LTP-Library-API-Writing-Guidelines.asciidoc} (100%)
 rename doc/{maintainer-patch-review-checklist.txt => Maintainer-Patch-Review-Checklist.asciidoc} (100%)
 rename doc/{shell-test-api.txt => Shell-Test-API.asciidoc} (100%)
 rename doc/{supported-kernel-libc-versions.txt => Supported-kernel,-libc,-toolchain-versions.asciidoc} (100%)
 rename doc/{test-writing-guidelines.txt => Test-Writing-Guidelines.asciidoc} (100%)
 rename doc/{user-guide.txt => User-Guidelines.asciidoc} (100%)

diff --git a/.github/workflows/wiki-mirror.yml b/.github/workflows/wiki-mirror.yml
index 883892bf5..2ac0caf74 100644
--- a/.github/workflows/wiki-mirror.yml
+++ b/.github/workflows/wiki-mirror.yml
@@ -38,20 +38,10 @@ jobs:
           commit=$(git log --pretty=format:"%h (\"%s\")" -1 .)
 
           cd $GITHUB_WORKSPACE/ltp.wiki
-
-          # Don't forget to update this list, keep it sorted
-          cp -v $dir/c-test-api.txt C-Test-API.asciidoc
-          cp -v $dir/c-test-tutorial-simple.txt C-Test-Case-Tutorial.asciidoc
-          cp -v $dir/library-api-writing-guidelines.txt LTP-Library-API-Writing-Guidelines.asciidoc
-          cp -v $dir/maintainer-patch-review-checklist.txt Maintainer-Patch-Review-Checklist.asciidoc
-          cp -v $dir/network-c-api.txt C-Test-Network-API.asciidoc
-          cp -v $dir/shell-test-api.txt Shell-Test-API.asciidoc
-          cp -v $dir/supported-kernel-libc-versions.txt Supported-kernel,-libc,-toolchain-versions.asciidoc
-          cp -v $dir/test-writing-guidelines.txt Test-Writing-Guidelines.asciidoc
-          cp -v $dir/user-guide.txt User-Guidelines.asciidoc
-          cp -v $dir/kvm-test-api.txt KVM-Test-API.asciidoc
-
+          # don't forget to add new extensions
+          cp -v $dir/*.asciidoc $dir/*.rest .
           git add .
+
           # only commit if there are changes
           git diff-index --quiet HEAD -- || git commit -m "Update to $commit" .
           git push
diff --git a/doc/build-system-guide.txt b/doc/Build-System.rest
similarity index 100%
rename from doc/build-system-guide.txt
rename to doc/Build-System.rest
diff --git a/doc/c-test-api.txt b/doc/C-Test-API.asciidoc
similarity index 100%
rename from doc/c-test-api.txt
rename to doc/C-Test-API.asciidoc
diff --git a/doc/c-test-tutorial-simple.txt b/doc/C-Test-Case-Tutorial.asciidoc
similarity index 100%
rename from doc/c-test-tutorial-simple.txt
rename to doc/C-Test-Case-Tutorial.asciidoc
diff --git a/doc/network-c-api.txt b/doc/C-Test-Network-API.asciidoc
similarity index 100%
rename from doc/network-c-api.txt
rename to doc/C-Test-Network-API.asciidoc
diff --git a/doc/kvm-test-api.txt b/doc/KVM-Test-API.asciidoc
similarity index 100%
rename from doc/kvm-test-api.txt
rename to doc/KVM-Test-API.asciidoc
diff --git a/doc/library-api-writing-guidelines.txt b/doc/LTP-Library-API-Writing-Guidelines.asciidoc
similarity index 100%
rename from doc/library-api-writing-guidelines.txt
rename to doc/LTP-Library-API-Writing-Guidelines.asciidoc
diff --git a/doc/maintainer-patch-review-checklist.txt b/doc/Maintainer-Patch-Review-Checklist.asciidoc
similarity index 100%
rename from doc/maintainer-patch-review-checklist.txt
rename to doc/Maintainer-Patch-Review-Checklist.asciidoc
diff --git a/doc/shell-test-api.txt b/doc/Shell-Test-API.asciidoc
similarity index 100%
rename from doc/shell-test-api.txt
rename to doc/Shell-Test-API.asciidoc
diff --git a/doc/supported-kernel-libc-versions.txt b/doc/Supported-kernel,-libc,-toolchain-versions.asciidoc
similarity index 100%
rename from doc/supported-kernel-libc-versions.txt
rename to doc/Supported-kernel,-libc,-toolchain-versions.asciidoc
diff --git a/doc/test-writing-guidelines.txt b/doc/Test-Writing-Guidelines.asciidoc
similarity index 100%
rename from doc/test-writing-guidelines.txt
rename to doc/Test-Writing-Guidelines.asciidoc
diff --git a/doc/user-guide.txt b/doc/User-Guidelines.asciidoc
similarity index 100%
rename from doc/user-guide.txt
rename to doc/User-Guidelines.asciidoc
-- 
2.40.0


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

[LTP] [RFC PATCH 2/2] doc: Add Release procedure

[Petr Vorel]

This slightly outdated document exists in LTP wiki, start versioning it
in the original repository. The only unversioned file in the wiki is
now Home.rest.

Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
This should be updated, so I'm ok not to merge it and prepare more up to
date version (although I'd need Cyril's help).

Also (separate effort), there is unversioned script, which could be
added to git. And we could remove Makefile.release, which IMHO is not
used (although it solves dependency: running autotools and distclean;
maybe we could combine both: Add script and add make target which would
run the script after solving the dependencies).

Kind regards,
Petr

 doc/LTP-Release-Procedure.asciidoc | 67 ++++++++++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 doc/LTP-Release-Procedure.asciidoc

diff --git a/doc/LTP-Release-Procedure.asciidoc b/doc/LTP-Release-Procedure.asciidoc
new file mode 100644
index 000000000..cd7682fb8
--- /dev/null
+++ b/doc/LTP-Release-Procedure.asciidoc
@@ -0,0 +1,67 @@
+LTP Release Procedure
+=====================
+
+This page contains quick summary of what needs to be done to do a LTP release. It's expected that LTP git is frozen and git HEAD was properly tested and that LTP git tree is cloned to a directory named 'ltp'.
+
+NOTE: The string YYYYMMDD should be substituted to the current date.
+
+1. Tag the git
+--------------
+
+[source,sh]
+--------------------------------------------------------------------
+cd ltp
+echo YYYYMMDD > VERSION
+git commit -s -m 'LTP YYYYMMDD' VERSION
+git tag -a YYYYMMDD -m 'LTP YYYYMMDD'
+--------------------------------------------------------------------
+
+2. Push changes to github
+-------------------------
+[source,sh]
+--------------------------------------------------------------------
+git push
+git push --tags
+--------------------------------------------------------------------
+
+3. Prepare tarballs
+-------------------
+[source,sh]
+--------------------------------------------------------------------
+cd ..
+git clone ltp ltp-full-YYYYMMDD
+cd ltp-full-YYYYMMDD
+# Update mce-inject submodule
+git submodule init
+git submodule update
+# Generate configure script
+make autotools
+# Prepare the archives
+cd ..
+tar -cjf ltp-full-YYYYMMDD.tar.bz2 ltp-full-YYYYMMDD --exclude .git
+tar -cJf ltp-full-YYYYMMDD.tar.xz ltp-full-YYYYMMDD --exclude .git
+--------------------------------------------------------------------
+
+4. Upload the tarballs to GitHub
+--------------------------------
+
+Click on 'releases' then switch to 'tags' then click on 'Add release notes' there should be 'Attach binaries ...' link at the bottom of the page.
+
+Don't forget to upload md5 and sha-1 sums for the tarballs as well.
+
+5. Send release announcement
+----------------------------
+
+Have a look at http://sourceforge.net/p/ltp/mailman/message/34429656/ to get the idea how it should look.
+
+The announcement is send to:
+
+* ltp at lists.linux.it
+* linux-kernel at vger.kernel.org
+* libc-alpha at sourceware.org
+
+CCed to:
+
+* lwn at lwn.net
+* akpm at linux-foundation.org
+* torvalds at linux-foundation.org.
\ No newline at end of file
-- 
2.40.0


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

Re: [LTP] [RFC PATCH 2/2] doc: Add Release procedure

[Li Wang]

Hi Petr,

Thanks for drafting this, quite useful~

On Tue, Mar 28, 2023 at 7:14 PM Petr Vorel <pvorel@suse.cz> wrote:
>
> This slightly outdated document exists in LTP wiki, start versioning it
> in the original repository. The only unversioned file in the wiki is
> now Home.rest.
>
> Signed-off-by: Petr Vorel <pvorel@suse.cz>
> ---
> This should be updated, so I'm ok not to merge it and prepare more up to
> date version (although I'd need Cyril's help).
>
> Also (separate effort), there is unversioned script, which could be
> added to git. And we could remove Makefile.release, which IMHO is not
> used (although it solves dependency: running autotools and distclean;
> maybe we could combine both: Add script and add make target which would
> run the script after solving the dependencies).
>
> Kind regards,
> Petr
>
>  doc/LTP-Release-Procedure.asciidoc | 67 ++++++++++++++++++++++++++++++
>  1 file changed, 67 insertions(+)
>  create mode 100644 doc/LTP-Release-Procedure.asciidoc
>
> diff --git a/doc/LTP-Release-Procedure.asciidoc b/doc/LTP-Release-Procedure.asciidoc
> new file mode 100644
> index 000000000..cd7682fb8
> --- /dev/null
> +++ b/doc/LTP-Release-Procedure.asciidoc
> @@ -0,0 +1,67 @@
> +LTP Release Procedure
> +=====================
> +
> +This page contains quick summary of what needs to be done to do a LTP release. It's expected that LTP git is frozen and git HEAD was properly tested and that LTP git tree is cloned to a directory named 'ltp'.

Should we mention the release is happening every 4 months?

> +NOTE: The string YYYYMMDD should be substituted to the current date.

Or, maybe add one more item about the release eve work?
Like what we discussed in:
  - https://lists.linux.it/pipermail/ltp/2022-September/030614.html

For example:

0. Release eve work
---------------------------

[source,sh]
--------------------------------------------------------------------

a. Collecting the (must have) patch list for new release
b. Reviewing and merging the patch list of (a.)
c. Widely testing, explicitly post results
d. Tiny fix according to release testing
e. Writing release note
...
--------------------------------------------------------------------


> +1. Tag the git
> +--------------
> +
> +[source,sh]
> +--------------------------------------------------------------------
> +cd ltp
> +echo YYYYMMDD > VERSION
> +git commit -s -m 'LTP YYYYMMDD' VERSION
> +git tag -a YYYYMMDD -m 'LTP YYYYMMDD'
> +--------------------------------------------------------------------
> +
> +2. Push changes to github
> +-------------------------
> +[source,sh]
> +--------------------------------------------------------------------
> +git push
> +git push --tags
> +--------------------------------------------------------------------
> +
> +3. Prepare tarballs
> +-------------------
> +[source,sh]
> +--------------------------------------------------------------------
> +cd ..
> +git clone ltp ltp-full-YYYYMMDD
> +cd ltp-full-YYYYMMDD
> +# Update mce-inject submodule
> +git submodule init
> +git submodule update
> +# Generate configure script
> +make autotools
> +# Prepare the archives
> +cd ..
> +tar -cjf ltp-full-YYYYMMDD.tar.bz2 ltp-full-YYYYMMDD --exclude .git
> +tar -cJf ltp-full-YYYYMMDD.tar.xz ltp-full-YYYYMMDD --exclude .git
> +--------------------------------------------------------------------
> +
> +4. Upload the tarballs to GitHub
> +--------------------------------
> +
> +Click on 'releases' then switch to 'tags' then click on 'Add release notes' there should be 'Attach binaries ...' link at the bottom of the page.
> +
> +Don't forget to upload md5 and sha-1 sums for the tarballs as well.
> +
> +5. Send release announcement
> +----------------------------
> +
> +Have a look at http://sourceforge.net/p/ltp/mailman/message/34429656/ to get the idea how it should look.
> +
> +The announcement is send to:
> +
> +* ltp at lists.linux.it
> +* linux-kernel at vger.kernel.org
> +* libc-alpha at sourceware.org
> +
> +CCed to:
> +
> +* lwn at lwn.net
> +* akpm at linux-foundation.org
> +* torvalds at linux-foundation.org.
> \ No newline at end of file
> --
> 2.40.0
>


--
Regards,
Li Wang


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

Re: [LTP] [RFC PATCH 2/2] doc: Add Release procedure

[Petr Vorel]

Hi Li,

> > +++ b/doc/LTP-Release-Procedure.asciidoc
> > @@ -0,0 +1,67 @@
> > +LTP Release Procedure
> > +=====================
> > +
> > +This page contains quick summary of what needs to be done to do a LTP release. It's expected that LTP git is frozen and git HEAD was properly tested and that LTP git tree is cloned to a directory named 'ltp'.

> Should we mention the release is happening every 4 months?

> > +NOTE: The string YYYYMMDD should be substituted to the current date.

> Or, maybe add one more item about the release eve work?
> Like what we discussed in:
>   - https://lists.linux.it/pipermail/ltp/2022-September/030614.html

> For example:

> 0. Release eve work
> ---------------------------

> [source,sh]
> --------------------------------------------------------------------

> a. Collecting the (must have) patch list for new release
> b. Reviewing and merging the patch list of (a.)
> c. Widely testing, explicitly post results
> d. Tiny fix according to release testing
> e. Writing release note
> ...
> --------------------------------------------------------------------

Very good point, I agree with both. Thanks!

Kind regards,
Petr

> > +1. Tag the git
> > +--------------
...

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp