Page MenuHomeSoftware Heritage

docs: Add new "howto write a lister tutorial" with unified lister api
ClosedPublic

Authored by ardumont on Fri, Feb 12, 12:08 PM.

Details

Summary

This adds a new tutorial which details how to currently write the new listers (both
incremental or stateless). This proposes a python template file to start a new lister.

At last, this renames the previous tutorial into tutorial-2017.

Related to T3073

Diff Detail

Repository
rDLS Listers
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 D5069 (id=18089)

Rebasing onto 5b4dc289b7...

Current branch diff-target is up to date.
Changes applied before test
commit 52eaa46183d8ceef85746c2161facb42cdff997f
Author: tenma <tenma+swh@mailbox.org>
Date:   Fri Feb 12 11:41:01 2021 +0100

    docs: Add a new lister tutorial for latest API

commit 7cdc3b9e622fbb2c1f6b762c346f885565998e5a
Author: tenma <tenma+swh@mailbox.org>
Date:   Fri Feb 12 11:20:30 2021 +0100

    docs: Fix old tutorial and prepare for the new one

commit b6b08e2b017b56630c69372662e0bc93560aabe0
Author: tenma <tenma+swh@mailbox.org>
Date:   Fri Jan 22 15:50:34 2021 +0100

    docs: Add a template for the latest lister API

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

tenma retitled this revision from Write the new lister tutorial for latest API to New lister tutorial for latest API.Fri, Feb 12, 5:10 PM
tenma edited the summary of this revision. (Show Details)
tenma added projects: Lister, Documentation.

lgtm, thanks. a bunch of typo-fixing comments below

docs/tutorial.rst
77–78
80

what does [1] reference?

111
113
134–135
190–191
195
241–245
253–255
289–293
295

this is not a persistent id! (and the line numbers are likely to rot)

343–346
ardumont added a reviewer: tenma.
ardumont added a subscriber: ardumont.

Let's not make this great piece of doc wait any longer.

I'll take it over and adapt according to val's remark.

ardumont retitled this revision from New lister tutorial for latest API to docs: Add new "howto write a lister tutorial" with unified lister api.

Build is green

Patch application report for D5069 (id=18452)

Rebasing onto 5b4dc289b7...

Current branch diff-target is up to date.
Changes applied before test
commit 17b221c233582aaf2ec0154366809bcdab1d3c12
Author: tenma <tenma+swh@mailbox.org>
Date:   Fri Feb 26 14:59:13 2021 +0100

    Add new lister tutorial for latest API
    
    This adds a new tutorial which details how to currently write the new listers (both
    incremental or stateless). This proposes a python template file to start a new lister.
    
    At last, this renames the previous tutorial into tutorial-2017.
    
    Related to T3073

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

roh, i had forgotten to commit the main subject commit line, fixed!

I forgot to C-c C-c ¯\_(ツ)_/¯

Build is green

Patch application report for D5069 (id=18454)

Rebasing onto 5b4dc289b7...

Current branch diff-target is up to date.
Changes applied before test
commit 2e17729e970ff84b595fc70edcfaeffbf44e1888
Author: tenma <tenma+swh@mailbox.org>
Date:   Fri Feb 26 14:59:13 2021 +0100

    docs: Add new "howto write a lister tutorial" with unified lister api
    
    This adds a new tutorial which details how to currently write the new listers (both
    incremental or stateless). This proposes a python template file to start a new lister.
    
    At last, this renames the previous tutorial into tutorial-2017.
    
    Related to T3073

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

I trust that you made the changes I suggested

This revision is now accepted and ready to land.Fri, Feb 26, 5:08 PM

I trust that you made the changes I suggested

I did and i went up to the point of marking them done in that diff ;)