Paths

Table of Contentst

doc: document configuration file location
ClosedPublic
Actions

Authored by zack on Oct 16 2020, 1:22 PM.

Details

Reviewers

haltode
seirl

Commits

rDFUSE490c0de038f3: configuration doc: convert tabs to spaces
rDFUSE61afd3a428d1: doc: document configuration file location

Summary

doc: document configuration file location

also apply various other minor improvements to the configuration documentation:

mention and show in the example the outer "swh > fuse" stanza
fix sphinx markup for verbatim text (it's "`", not "")
add configuration file doc to the doc index

Test Plan

tox

Diff Detail

Repository

rDFUSE FUSE virtual file system

Branch

feature/doc-conffile

Lint

No Linters Available

Unit

No Unit Test Coverage

Build Status

Buildable 16374
Build 25217: Phabricator diff pipeline on jenkins	Jenkins console · Jenkins
Build 25216: arc lint + arc unit

Event Timeline

zack created this revision.Oct 16 2020, 1:22 PM

Build is green

Patch application report for D4285 (id=15146)

Rebasing onto bbcd975f8c...

Current branch diff-target is up to date.

Changes applied before test

commit b6f1e98a09f5b27523d7d2c89dc94eeeb469ba5f
Author: Stefano Zacchiroli <zack@upsilon.cc>
Date:   Fri Oct 16 13:16:52 2020 +0200

    doc: document configuration file location
    
    also apply various other minor improvements to the configuration documentation:
    
    - mention and show in the example the outer "swh > fuse" stanza
    
    - fix sphinx markup for verbatim text (it's "``", not "`")

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

Harbormaster completed remote builds in B16374: Diff 15146.Oct 16 2020, 1:23 PM

better commit message

zack edited the summary of this revision. (Show Details)Oct 16 2020, 1:24 PM

zack edited the summary of this revision. (Show Details)

Build is green

Patch application report for D4285 (id=15147)

Rebasing onto bbcd975f8c...

Current branch diff-target is up to date.

Changes applied before test

commit 61afd3a428d1f7b05c5a20a5dc340b9c5a099bab
Author: Stefano Zacchiroli <zack@upsilon.cc>
Date:   Fri Oct 16 13:16:52 2020 +0200

    doc: document configuration file location
    
    also apply various other minor improvements to the configuration documentation:
    
    - mention and show in the example the outer "swh > fuse" stanza
    - fix sphinx markup for verbatim text (it's "``", not "`")
    - add configuration file doc to the doc index

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

Harbormaster completed remote builds in B16375: Diff 15147.Oct 16 2020, 1:25 PM

haltode requested changes to this revision.Oct 16 2020, 1:52 PM

haltode added inline comments.

docs/configuration.rst
50–59	Please fix indentation (tabs starting at the `cache` entry until the end)

This revision now requires changes to proceed.Oct 16 2020, 1:52 PM

configuration doc: convert tabs to spaces

Build is green

Patch application report for D4285 (id=15154)

Rebasing onto bbcd975f8c...

Current branch diff-target is up to date.

Changes applied before test

commit 490c0de038f3ad7109fb4eaf0ff072ce0cbc4b5f
Author: Stefano Zacchiroli <zack@upsilon.cc>
Date:   Fri Oct 16 14:00:50 2020 +0200

    configuration doc: convert tabs to spaces
    
    h/t @haltode

commit 61afd3a428d1f7b05c5a20a5dc340b9c5a099bab
Author: Stefano Zacchiroli <zack@upsilon.cc>
Date:   Fri Oct 16 13:16:52 2020 +0200

    doc: document configuration file location
    
    also apply various other minor improvements to the configuration documentation:
    
    - mention and show in the example the outer "swh > fuse" stanza
    - fix sphinx markup for verbatim text (it's "``", not "`")
    - add configuration file doc to the doc index

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

Harbormaster completed remote builds in B16382: Diff 15154.Oct 16 2020, 2:02 PM

haltode accepted this revision.Oct 16 2020, 2:02 PM

This revision is now accepted and ready to land.Oct 16 2020, 2:02 PM

Closed by commit rDFUSE61afd3a428d1: doc: document configuration file location (authored by zack). · Explain WhyOct 16 2020, 2:02 PM

This revision was automatically updated to reflect the committed changes.

zack added a commit: rDFUSE61afd3a428d1: doc: document configuration file location.

zack added a commit: rDFUSE490c0de038f3: configuration doc: convert tabs to spaces.