Page MenuHomeSoftware Heritage

Start writing a package loader tutorial.
ClosedPublic

Authored by vlorentz on Thu, Apr 1, 2:14 PM.

Details

Summary

This contains the basic, from creating files to getting a working
(but untested and inefficient) loader.

Diff Detail

Repository
rDLDBASE Generic VCS/Package Loader
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

Build is green

Patch application report for D5401 (id=19328)

Rebasing onto ec5a76c6d9...

Current branch diff-target is up to date.
Changes applied before test
commit 12a64b87f040fa455650dedb1c0080159fc6714d
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Apr 1 14:14:05 2021 +0200

    Start writing a package loader tutorial.
    
    This contains the basic, from creating files to getting a working
    (but untested and inefficient) loader.

See https://jenkins.softwareheritage.org/job/DLDBASE/job/tests-on-diff/457/ for more details.

ardumont added inline comments.
docs/package-loader-tutorial.rst
20
27

NewLoader? to matcher the lister docs?

docs/package-loader-tutorial.rst
20

both wordings are correct

docs/package-loader-tutorial.rst
20

indeed, i realize only now and i prefer yours now ;)

55

or is it some sphinx stuff?

98

Build is green

Patch application report for D5401 (id=19348)

Rebasing onto ec5a76c6d9...

Current branch diff-target is up to date.
Changes applied before test
commit 309d831cf1cac10622c9434f06a7e8cd02b1ef5c
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Apr 1 14:14:05 2021 +0200

    Start writing a package loader tutorial.
    
    This contains the basic, from creating files to getting a working
    (but untested and inefficient) loader.

See https://jenkins.softwareheritage.org/job/DLDBASE/job/tests-on-diff/458/ for more details.

docs/package-loader-tutorial.rst
107

this sentence sounds strange to me.
I'm not sure exactly what you meant...
ah maybe:

Thee optional field ``url``, if provided, must be an URL where to download the filename.
Please, provide it when relevant/possible.

Thanks.

That documentation start looks good to me. A few suggestions inline.

I'll take that the TODOs will be done incrementally in future diffs.
So you can go ahead and merge it if you wish to.

This revision is now accepted and ready to land.Fri, Apr 2, 11:30 AM
docs/package-loader-tutorial.rst
107

that sentence is clearly missing some words, let me fix it :p

fix missing words

docs/package-loader-tutorial.rst
55

it is

Build is green

Patch application report for D5401 (id=19349)

Rebasing onto ec5a76c6d9...

Current branch diff-target is up to date.
Changes applied before test
commit 0eeb712bb1620df4075b8f7057f86abe4fd149aa
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Apr 1 14:14:05 2021 +0200

    Start writing a package loader tutorial.
    
    This contains the basic, from creating files to getting a working
    (but untested and inefficient) loader.

See https://jenkins.softwareheritage.org/job/DLDBASE/job/tests-on-diff/459/ for more details.