Documentation and Configuration confusion

Bug #400344 reported by dobey
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Tarmac
Fix Released
Medium
Paul Hummer

Bug Description

Tarmac's documentation is slightly confusing where talking about configuration. Outside of the configuration.txt document (in plugins.txt for example), there is no talk about where the configuration goes. Also, the logging system seems to log in ~/.config/tarmac/$projectname and the documentation has examples like:

[tarmac]
foo=bar

This sort of implies that it should be a [tarmac] section inside ~/.config/tarmac/$projectname... until you open the file to see that it is logging output. The logs should be moved to the cache directory (using config.CACHE_ROOT after my xdg branch lands), and the config documentation should be clearer by using ProjectName as the example rather than tarmac, as well as referencing configuration.txt about where to place such configuration.

Paul Hummer (rockstar)
tags: added: documentation
Changed in tarmac:
status: New → Triaged
importance: Undecided → Medium
Paul Hummer (rockstar)
Changed in tarmac:
milestone: none → tarmac-0.3
Revision history for this message
Paul Hummer (rockstar) wrote :

Combined all the docs into a single document in revno 283

Changed in tarmac:
status: Triaged → In Progress
assignee: nobody → Paul Hummer (rockstar)
status: In Progress → Fix Committed
Paul Hummer (rockstar)
Changed in tarmac:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.