Control: reassign -1 debci

Dear Paul

You're looking at this file:
https://salsa.debian.org/ci-team/debci/blob/master/docs/TUTORIAL.md

It would be awesome if you could propose changes to that file instead of
the generated html file. However, I already have some comments.

On 03-09-18 06:42, Paul Hardy wrote:
> Please consider adding "The test environment" section (or something
> like it) that I added to the autopkgtest tutorial page.  It gives an
> introductory description of the general environment in which a CI test
> script runs in a way that I have not found elsewhere.

Although I appreciate what you try to do here, it rather feels weird, as
you are just describing a very standard Debian setup. I really think
this is not the place to describe how Debian works and where packages
install their files. Policy already does that. So your first paragraph
could be "The test environment is a minimalistic standard Debian
installation."

Your second sentence basically repeats stuff that is in the autopkgtest
spec. Maybe we should more clearly link that?
https://salsa.debian.org/ci-team/autopkgtest/raw/master/doc/README.package-tests.rst

$PATH will just contain the default Debian $PATH, again, I think this is
described in Debian policy. The location of the scripts is described in
the spec again.

> The file is
> small, so I am attaching the whole gzipped file to avoid possible
> issues with diff on the very long line that is the table of contents
> list at the start of the file.  The original web page is at
> 
>      https://ci.debian.net/doc/file.TUTORIAL.html

As mentioned above, this is a generated file, please have a look at the
source linked above.

> I copied the two paragraphs that describe AUTOPKGTEST_TMP and
> AUTOPKGTEST_ARCHIVE from
> 
>      https://people.debian.org/~mpitt/autopkgtest/README.package-tests.html

Hmm, we live on salsa nowadays, please follow the link above. And
instead of repeating stuff, can't we make smart text around links?

> I do not know if what I wrote is accurate, because I do not understand
> every virtual environment where autopkgtest can run.  Resolving my
> uncertainty will hopefully let me write optimal CI test scripts in the
> future.  What I have written, though, is background information that I
> did not see anywhere.  It would have saved me time when I started
> trying to use CI testing; hopefully it will save others time.

The README you referred to is an old one. I propose you read the current
one and propose improvements to that file instead of the one you are
aiming at now (although all improvements to that one are very welcome,
don't let my response put you off).

> I am submitting this as a new bug rather than modifying bug #906617,
> because I would like to still have at least prefix=/usr and DESTDIR=""
> defined if that sounds reasonable.  I will add a note to that effect
> on that bug later.  If they are defined like that, I can provide a
> further patch to add mention of them to this tutorial web page.

Thanks for trying to improve our documentation.

Paul

Attachment: signature.asc
Description: OpenPGP digital signature

Reply via email to