Page MenuHomeSoftware Heritage

docs: add configuration.rst
ClosedPublic

Authored by haltode on Fri, Oct 9, 1:46 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

haltode created this revision.Fri, Oct 9, 1:46 PM
haltode updated this revision to Diff 14878.Fri, Oct 9, 1:47 PM

Add task number in commit message.

Build is green

Patch application report for D4218 (id=14877)

Rebasing onto 74607ba9d0...

Current branch diff-target is up to date.
Changes applied before test
commit 6c75bf8cc26e0a78e30d9f799267d00dc7712ade
Author: Thibault Allançon <haltode@gmail.com>
Date:   Fri Oct 9 13:46:25 2020 +0200

    docs: add configuration.rst

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

Build is green

Patch application report for D4218 (id=14878)

Rebasing onto 74607ba9d0...

Current branch diff-target is up to date.
Changes applied before test
commit c59eed497bb2e1f86dc3541d5af9531e5c549121
Author: Thibault Allançon <haltode@gmail.com>
Date:   Fri Oct 9 13:46:25 2020 +0200

    docs: add configuration.rst
    
    Closes T2673.

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

zack requested changes to this revision.Fri, Oct 9, 1:50 PM
zack added a subscriber: zack.
  • can you please add info about where the configuration file is located? (both by default and w.r.t. XDG_CONFIG_HOME, if applicable)
  • as people might not be familiar with YAML quirks, having an example of a skeleton config file, in full concrete syntax, would be also useful
This revision now requires changes to proceed.Fri, Oct 9, 1:50 PM
haltode updated this revision to Diff 14884.Fri, Oct 9, 2:10 PM

Add full YAML example

Build is green

Patch application report for D4218 (id=14884)

Rebasing onto 74607ba9d0...

Current branch diff-target is up to date.
Changes applied before test
commit 7683ad175a213172835c33178da5b33018bc1806
Author: Thibault Allançon <haltode@gmail.com>
Date:   Fri Oct 9 13:46:25 2020 +0200

    docs: add configuration.rst
    
    Closes T2673.

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

T2678 (for the first point about default configuration location).

zack accepted this revision.Fri, Oct 9, 2:17 PM

LGTM

please just fix the inconsistency in quoting in the example before landing, it is not clear to me why url is quoted whereas path is not

This revision is now accepted and ready to land.Fri, Oct 9, 2:17 PM
haltode updated this revision to Diff 14885.Fri, Oct 9, 2:17 PM

Add quotes in YAML path entry

Build is green

Patch application report for D4218 (id=14885)

Rebasing onto 74607ba9d0...

Current branch diff-target is up to date.
Changes applied before test
commit d759b9b3b751c2d1d351eb50b6a0800ef7e71559
Author: Thibault Allançon <haltode@gmail.com>
Date:   Fri Oct 9 13:46:25 2020 +0200

    docs: add configuration.rst
    
    Closes T2673.

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

This revision was automatically updated to reflect the committed changes.