Page MenuHomeSoftware Heritage

FUSE: docs: tutorial: add origin and search examples
ClosedPublic

Authored by haltode on Mon, Dec 28, 11:40 AM.

Details

Summary
  • docs: tutorial: add origin and search examples
  • requirements-swh: bump swh.web.client to latest 0.2.4

Fix T2825.

Diff Detail

Repository
rDFUSE FUSE virtual file system
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 D4793 (id=16966)

Rebasing onto ef5806f5de...

Current branch diff-target is up to date.
Changes applied before test
commit 36cc6737690fcdfa9c03f73d927ac82ac2ce425a
Author: Thibault Allançon <haltode@gmail.com>
Date:   Mon Dec 28 11:37:12 2020 +0100

    docs: tutorial: add origin and search examples
    
    Fix T2825.

commit 5dbf0a69253ffe83badc05b1252ab069fe38103a
Author: Thibault Allançon <haltode@gmail.com>
Date:   Mon Dec 28 10:56:41 2020 +0100

    requirements-swh: bump swh.web.client to latest 0.2.4

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

This revision is now accepted and ready to land.Mon, Dec 28, 11:49 AM
zack requested changes to this revision.Mon, Dec 28, 11:53 AM
This revision now requires changes to proceed.Mon, Dec 28, 11:53 AM
docs/tutorial.md
227 ↗(On Diff #16966)

"in" -> "via" or "from"

239 ↗(On Diff #16966)

"@" comes from your own "ls" alias. As it is relevant to your example, you should make sure "ls" is passed the right flags to output it in any condition. All in all, for this examples you might want to show an output of "ls -l", which will also show where the symlinks point to.

241–244 ↗(On Diff #16966)

The important point of swh search here is not only that it escapes, but also that it finds, because users would have very little chance of finding the right origin URL. So, concrete proposal:

  • say that swh search is useful to find origin URLs
  • show an example of it without escaping, so that readers understand that
  • then show an example of it with escaping, as you did here
haltode marked 3 inline comments as done.

Fix zack comments

Build is green

Patch application report for D4793 (id=16967)

Rebasing onto ef5806f5de...

Current branch diff-target is up to date.
Changes applied before test
commit 4b304d38eee0175208b88f30fa0e2307f0f43cd2
Author: Thibault Allançon <haltode@gmail.com>
Date:   Mon Dec 28 11:37:12 2020 +0100

    docs: tutorial: add origin and search examples
    
    Fix T2825.

commit 5dbf0a69253ffe83badc05b1252ab069fe38103a
Author: Thibault Allançon <haltode@gmail.com>
Date:   Mon Dec 28 10:56:41 2020 +0100

    requirements-swh: bump swh.web.client to latest 0.2.4

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

This revision is now accepted and ready to land.Mon, Dec 28, 12:41 PM