[LTP] [PATCH 0/2] github pull request template

[LTP] [PATCH 0/2] github pull request template

[Petr Vorel]

Petr Vorel (2):
  github: pull_request_template.md
  doc/c-test-tutorial-simple.txt: Use links, README.md

 .github/pull_request_template.md |  6 ++++++
 doc/c-test-tutorial-simple.txt   | 21 +++++++++++----------
 2 files changed, 17 insertions(+), 10 deletions(-)
 create mode 100644 .github/pull_request_template.md

-- 
2.37.1


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

[LTP] [PATCH 1/2] github: pull_request_template.md

[Petr Vorel]

From: Petr Vorel <pevik@users.noreply.github.com>

Create pull request template to inform people that we prefer patches to
our mailing list. We have this info in README.md, but even experienced,
who send patches with git send-email to other projects overlook this
info and open github pull requests.

While at it, add links to the test case tutorial, lore and patchwork.

Template does not support any formatting, therefore using plain links.

Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
NOTE: you can test it if you fork from my fork:
https://github.com/pevik/ltp

 .github/pull_request_template.md | 6 ++++++
 1 file changed, 6 insertions(+)
 create mode 100644 .github/pull_request_template.md

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 000000000..68c8a6499
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,6 @@
+Although we *occasionally* also accept GitHub pull requests, the *preferred* way is sending patches to our mailing list: https://lore.kernel.org/ltp/
+
+There is an example how to use it: https://github.com/linux-test-project/ltp/wiki/C-Test-Case-Tutorial#7-submitting-the-test-for-review (using git format-patch and git send-email).
+
+LTP mailing list is archived: https://lore.kernel.org/ltp/.
+We also have a patchwork instance: https://patchwork.ozlabs.org/project/ltp/list/.
-- 
2.37.1


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

[LTP] [PATCH 2/2] doc/c-test-tutorial-simple.txt: Use links, README.md

[Petr Vorel]

Symlinks to LTP wiki are more friendly for people reading web (likely
the most of the people) while styl readable when reading locally.

Adding links to git format-patch and send-email (people can google, but
again be nice to readers on the web).

Fix local name: s/README/README.md/

Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
 doc/c-test-tutorial-simple.txt | 21 +++++++++++----------
 1 file changed, 11 insertions(+), 10 deletions(-)

diff --git a/doc/c-test-tutorial-simple.txt b/doc/c-test-tutorial-simple.txt
index c09613e37..c25a5f4d2 100644
--- a/doc/c-test-tutorial-simple.txt
+++ b/doc/c-test-tutorial-simple.txt
@@ -24,15 +24,16 @@ and has some general knowledge of Operating Systems. Experienced Linux
 developers may find it too verbose while people new to system level Linux
 development may find it overwhelming.
 
-Comments and feedback are welcome, please direct them to the mailing list (see
-+README+).
+Comments and feedback are welcome, please direct them to
+https://lists.linux.it/listinfo/ltp[the mailing list].
 
 1. Getting Started
 ------------------
 
-Git-clone the main LTP repository as described in the +README+ and change
-directory to the checked-out Git repository. We recommend installing the LTP
-and running one of the tests mentioned in the Quick guide (in the +README+) to
+Git-clone the main LTP repository as described in
+https://github.com/linux-test-project/ltp#quick-guide-to-running-the-tests[the +README.md+]
+and change directory to the checked-out Git repository. We recommend installing the LTP
+and running one of the tests mentioned in the Quick guide (in the +README.md+) to
 ensure you are starting from a good state.
 
 We also recommended cloning the Linux kernel repository for reference, this
@@ -220,7 +221,7 @@ $ ./statx01
 
 This should build the test and then run it. However, even though the test is
 in the +syscalls+ directory it won't be automatically ran as part of the
-_syscalls_ test group (remember +./runltp -f syscalls+ from the +README+?). For
+_syscalls_ test group (remember +./runltp -f syscalls+ from the +README.md+?). For
 this we need to add it to the +runtest+ file. So open +runtest/statx+ and add
 the lines starting with a +++.
 
@@ -315,7 +316,7 @@ Check coding style with `make check`
 3.4 Install the LTP and run the test with runtest
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Run +statx01+ on its own; similar to the +madvise+ tests in the +README+.
+Run +statx01+ on its own; similar to the +madvise+ tests in the +README.md+.
 
 4. Call the system call
 -----------------------
@@ -980,9 +981,9 @@ of the conflict. Usually, all you need to do is remove the lines you don't
 want, stage the changes and continue the 'rebase' with +git rebase
 --continue+.
 
-In order to create a patch e-mail we use +git format-patch+, we can then send
-that e-mail using +git send-email+. It is also possible to import the patch
-(+mbox+) file into a number of e-mail programs.
+In order to create a patch e-mail we use https://git-scm.com/docs/git-format-patch[+git format-patch+],
+we can then send that e-mail using https://git-scm.com/docs/git-send-email[+git send-email+].
+It is also possible to import the patch (+mbox+) file into a number of e-mail programs.
 
 [source,shell]
 --------------------------------------------------------------------------------
-- 
2.37.1


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

Re: [LTP] [PATCH 1/2] github: pull_request_template.md

[Cyril Hrubis]

Hi!
> Create pull request template to inform people that we prefer patches to
> our mailing list. We have this info in README.md, but even experienced,
> who send patches with git send-email to other projects overlook this
> info and open github pull requests.
> 
> While at it, add links to the test case tutorial, lore and patchwork.
> 
> Template does not support any formatting, therefore using plain links.
> 
> Signed-off-by: Petr Vorel <pvorel@suse.cz>
> ---
> NOTE: you can test it if you fork from my fork:
> https://github.com/pevik/ltp
> 
>  .github/pull_request_template.md | 6 ++++++
>  1 file changed, 6 insertions(+)
>  create mode 100644 .github/pull_request_template.md
> 
> diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
> new file mode 100644
> index 000000000..68c8a6499
> --- /dev/null
> +++ b/.github/pull_request_template.md
> @@ -0,0 +1,6 @@
> +Although we *occasionally* also accept GitHub pull requests, the *preferred* way is sending patches to our mailing list: https://lore.kernel.org/ltp/
> +
> +There is an example how to use it: https://github.com/linux-test-project/ltp/wiki/C-Test-Case-Tutorial#7-submitting-the-test-for-review (using git format-patch and git send-email).
> +
> +LTP mailing list is archived: https://lore.kernel.org/ltp/.
                        ^
			archived at:
> +We also have a patchwork instance: https://patchwork.ozlabs.org/project/ltp/list/.

So this text is filled in the pull request as a message when user
creates it, right?

I guess that this is a creative misuse but I kind of like it :-).

Reviewed-by: Cyril Hrubis <chrubis@suse.cz>

-- 
Cyril Hrubis
chrubis@suse.cz

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

Re: [LTP] [PATCH 2/2] doc/c-test-tutorial-simple.txt: Use links, README.md

[Cyril Hrubis]

Hi!
> Symlinks to LTP wiki are more friendly for people reading web (likely
> the most of the people) while styl readable when reading locally.
                                ^
				still
> Adding links to git format-patch and send-email (people can google, but
> again be nice to readers on the web).
> 
> Fix local name: s/README/README.md/

Reviewed-by: Cyril Hrubis <chrubis@suse.cz>

-- 
Cyril Hrubis
chrubis@suse.cz

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

Re: [LTP] [PATCH 1/2] github: pull_request_template.md

[Petr Vorel]

> Hi!
> > Create pull request template to inform people that we prefer patches to
> > our mailing list. We have this info in README.md, but even experienced,
> > who send patches with git send-email to other projects overlook this
> > info and open github pull requests.

> > While at it, add links to the test case tutorial, lore and patchwork.

> > Template does not support any formatting, therefore using plain links.

> > Signed-off-by: Petr Vorel <pvorel@suse.cz>
> > ---
> > NOTE: you can test it if you fork from my fork:
> > https://github.com/pevik/ltp

> >  .github/pull_request_template.md | 6 ++++++
> >  1 file changed, 6 insertions(+)
> >  create mode 100644 .github/pull_request_template.md

> > diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
> > new file mode 100644
> > index 000000000..68c8a6499
> > --- /dev/null
> > +++ b/.github/pull_request_template.md
> > @@ -0,0 +1,6 @@
> > +Although we *occasionally* also accept GitHub pull requests, the *preferred* way is sending patches to our mailing list: https://lore.kernel.org/ltp/
> > +
> > +There is an example how to use it: https://github.com/linux-test-project/ltp/wiki/C-Test-Case-Tutorial#7-submitting-the-test-for-review (using git format-patch and git send-email).
> > +
> > +LTP mailing list is archived: https://lore.kernel.org/ltp/.
>                         ^
> 			archived at:
Ah, my poor English, I didn't know 'at' is mandatory.

> > +We also have a patchwork instance: https://patchwork.ozlabs.org/project/ltp/list/.

> So this text is filled in the pull request as a message when user
> creates it, right?
Yes :).

> I guess that this is a creative misuse but I kind of like it :-).
Thx!

> Reviewed-by: Cyril Hrubis <chrubis@suse.cz>

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

Re: [LTP] [PATCH 2/2] doc/c-test-tutorial-simple.txt: Use links, README.md

[Petr Vorel]

> Hi!
> > Symlinks to LTP wiki are more friendly for people reading web (likely
> > the most of the people) while styl readable when reading locally.
>                                 ^
> 				still
Lol, merged with this fixed + adding 'at' at previous commit.
Thanks!

Kind regards,
Petr

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

Re: [LTP] [PATCH 1/2] github: pull_request_template.md

[Petr Vorel]

> So this text is filled in the pull request as a message when user
> creates it, right?

> I guess that this is a creative misuse but I kind of like it :-).

BTW lazy reporters can just click on preview to get formatting + working symlinks :).
Petr

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