Page MenuHomeSoftware Heritage

FUSE: proof-read documentation
ClosedPublic

Authored by haltode on Tue, Dec 29, 12:18 PM.

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 D4797 (id=16976)

Rebasing onto bf87c60dd0...

Current branch diff-target is up to date.
Changes applied before test
commit c0b572543434857d50e9442100cdd364bc0317bd
Author: Thibault Allançon <haltode@gmail.com>
Date:   Tue Dec 29 12:16:34 2020 +0100

    docs: tutorial: update with most recent changes

commit 3deb976fbe0e77ce267650372d94d87f7308c149
Author: Thibault Allançon <haltode@gmail.com>
Date:   Tue Dec 29 12:16:14 2020 +0100

    docs: tutorial: fix typo

commit 91a252b8bbf50dc8ac4e8e606e02446bfe7d5abe
Author: Thibault Allançon <haltode@gmail.com>
Date:   Tue Dec 29 12:02:50 2020 +0100

    docs: design: update with most recent changes

commit 3c7a9d58563c95e66f8d7a3e4fbc2fcaa48629aa
Author: Thibault Allançon <haltode@gmail.com>
Date:   Tue Dec 29 11:56:57 2020 +0100

    docs: design: fix link syntax

commit 186df2b068a4f97a788d7e300cbee29529f16615
Author: Thibault Allançon <haltode@gmail.com>
Date:   Tue Dec 29 11:48:59 2020 +0100

    docs: configuration: update with most recent changes

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

This revision is now accepted and ready to land.Tue, Dec 29, 12:40 PM
zack requested changes to this revision.Wed, Dec 30, 8:57 AM
zack added inline comments.
docs/configuration.rst
22–23

maybe "boolean entry set to true or ..." (given true is the only meaningful value here, isn't it?)

27

"as a percentage of available RAM"

43–44

s/default// (you already said these are default values at the beginning of the list)

45

s/set to //

69

The example would be more meaningful with an actual (invalid) auth-token, instead of "null". I think the Web API auth token already have an example with an invalid auth token, which you can reuse here.

docs/design.md
72–73 ↗(On Diff #16976)

stop at the ","

the rest seems redundant

docs/tutorial.md
107–108 ↗(On Diff #16976)

Uhm, can it? The only mention of indentation i've found in the doc thus far is how much the indentation is, not the fact it is optional. We should fix the inconsistency.

This revision now requires changes to proceed.Wed, Dec 30, 8:57 AM
haltode marked 7 inline comments as done.

Fix zack comments

Build is green

Patch application report for D4797 (id=16984)

Rebasing onto bf87c60dd0...

Current branch diff-target is up to date.
Changes applied before test
commit 3a76424ac8f6ce6bea91470eca57b94983a26e11
Author: Thibault Allançon <haltode@gmail.com>
Date:   Tue Dec 29 12:16:34 2020 +0100

    docs: tutorial: update with most recent changes

commit 73d549e81205a3f06034dcc146fa8370643a64a0
Author: Thibault Allançon <haltode@gmail.com>
Date:   Tue Dec 29 12:16:14 2020 +0100

    docs: tutorial: fix typo

commit 5be1f36a8d444956e342e885da68d17c543d712d
Author: Thibault Allançon <haltode@gmail.com>
Date:   Tue Dec 29 12:02:50 2020 +0100

    docs: design: update with most recent changes

commit d799818bf6b091e6b257e4273e869411f107d0c9
Author: Thibault Allançon <haltode@gmail.com>
Date:   Tue Dec 29 11:56:57 2020 +0100

    docs: design: fix link syntax

commit 6c0987dbaa4ab163773f645dc9d9639708c9c4a8
Author: Thibault Allançon <haltode@gmail.com>
Date:   Tue Dec 29 11:48:59 2020 +0100

    docs: configuration: update with most recent changes

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

This revision is now accepted and ready to land.Mon, Jan 4, 9:42 AM