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

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

Details

Reviewers

vlorentz
zack

Group Reviewers

Reviewers

Maniphest Tasks

T2825: add origin (and search) example to the FUSE tutorial

Commits

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

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

Branch

feature/doc-tutorial-origin

Lint

No Linters Available

Unit

No Unit Test Coverage

Build Status

Buildable 18103
Build 27951: Phabricator diff pipeline on jenkins	Jenkins console · Jenkins
Build 27950: arc lint + arc unit

Event Timeline

haltode created this revision.Dec 28 2020, 11:40 AM

Herald added a reviewer: Reviewers. · View Herald TranscriptDec 28 2020, 11:40 AM

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.

Harbormaster completed remote builds in B18103: Diff 16966.Dec 28 2020, 11:44 AM

vlorentz accepted this revision.Dec 28 2020, 11:49 AM

This revision is now accepted and ready to land.Dec 28 2020, 11:49 AM

zack requested changes to this revision.Dec 28 2020, 11:53 AM

This revision now requires changes to proceed.Dec 28 2020, 11:53 AM

zack added inline comments.Dec 28 2020, 11:57 AM

docs/tutorial.md
227	"in" -> "via" or "from"
239	"@" 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	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

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.

Harbormaster completed remote builds in B18104: Diff 16967.Dec 28 2020, 12:24 PM

zack accepted this revision.Dec 28 2020, 12:41 PM

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

Closed by commit rDFUSE5dbf0a69253f: requirements-swh: bump swh.web.client to latest 0.2.4 (authored by haltode). · Explain WhyDec 28 2020, 1:35 PM

This revision was automatically updated to reflect the committed changes.

haltode added a commit: rDFUSE5dbf0a69253f: requirements-swh: bump swh.web.client to latest 0.2.4.

haltode added a commit: rDFUSE4b304d38eee0: docs: tutorial: add origin and search examples.