Opened 4 years ago

Closed 4 years ago

#15934 closed defect (fixed)

What is torrc.minimal.in-staging?!

Reported by: mrphs Owned by:
Priority: Medium Milestone:
Component: Core Tor/Tor Version:
Severity: Keywords:
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description (last modified by mrphs)

Reading from commit 8a79b56ac6709dfddaa15d9c76d0f856a502a6a1 it seems nickm has divided torrc into two files: torrc.minimal and torrc.sample. At the same time torrc.minimal.in-staging was introduced.

Is there any documentation somewhere explaining what is it and when do we need to edit it?

Child Tickets

Change History (6)

comment:1 Changed 4 years ago by mrphs

Description: modified (diff)

comment:2 Changed 4 years ago by nickm

So, the idea is that torrc.minimal should change as little as possible. So we should only change it very infrequently. But, we want to collect changes that will move into it. So, when you want to say "this is a change we should make to torrc.minimal the next time we change it", you change torrc.minimal.in-staging.

I'd welcome a README.config file in src/config ; anybody want to write one? :)

comment:3 in reply to:  2 Changed 4 years ago by mrphs

Replying to nickm:

So, the idea is that torrc.minimal should change as little as possible. So we should only change it very infrequently. But, we want to collect changes that will move into it. So, when you want to say "this is a change we should make to torrc.minimal the next time we change it", you change torrc.minimal.in-staging.

I think I'm a bit confused on what torrc.sample does, in this scenario.

comment:4 Changed 4 years ago by mrphs

It seems like torrc.sample.in and torrc.minimal.in-staging are identical.

How do you feel about having one torrc.sample.in file and a torrc.sample.in-staging file? (and removing the minimal ones).

Last edited 4 years ago by mrphs (previous) (diff)

comment:5 Changed 4 years ago by nickm

I think they should stay separate. "sample" and "minimal" serve different purposes.

"minimal" is meant to be the kind of thing that a distribution could drop in as /etc/torrc by default. Because of that, it's meant to change very infrequently, since even a comment change in /etc/torrc makes Debian users get prompted during each update. "sample" on the other hand can be full of information.

From the changelog:

    - Add a new, infrequently-changed "torrc.minimal". This file is
      similar to torrc.sample, but it will change as infrequently as
      possible, for the benefit of users whose systems prompt them for
      intervention whenever a default configuration file is changed.
      Making this change allows us to update torrc.sample to be a more
      generally useful "sample torrc".

comment:6 Changed 4 years ago by nickm

Resolution: fixed
Status: newclosed

Adding some document to src/config/README, closing this one.

Note: See TracTickets for help on using tickets.