Opened 12 years ago

Closed 11 years ago

#111 closed task (fixed)

Update build and install documenation

Reported by: jari Owned by: jari
Priority: major Milestone: 0.6
Component: documentation Version: trunk
Keywords: Cc:

Description (last modified by jari)

There are no test anymore. Tests are back but the docs should be updated.

Change History (12)

comment:1 Changed 12 years ago by peter

  • Component changed from core to documentation

comment:2 Changed 12 years ago by jari

  • Status changed from new to assigned

There are test again.

comment:3 Changed 12 years ago by peter

(In [281]) reorganized some of the build info. refs #111

comment:4 Changed 12 years ago by jari

  • Owner jari deleted
  • Status changed from assigned to new

comment:5 Changed 12 years ago by peter

I have been playing around a bit with the features in Trac, and found one neet little thing. You can set svn:mime-type to text/x-trac-wiki which implies Trac will interpret it as a wiki page when viewing the file in TracBrowser.

Why is this useful?

Well, it means we can have links to files in TracBrowser (which we already have in some projects) and the file will look good. Even better, we can have a link to for example /tags/0.6/INSTALL which then contains the information on how to install svndigest 0.6. This file INSTALL also is included in the distribution and by construction there is no descrepency between these two INSTALL instructions. In the same fashion we could have general instructions located in /doc e.g. /doc/readme.txt and on the Trac main page have a link to http://lev.thep.lu.se/trac/svndigest/browser/tags/0.6/doc/readme.txt. Thereby, we will get different versions of the INSTALL instructions, for example, because we can choose to browse in different branches (mainly trunk and tags).

For an example how it could look take a glance at Pantai project

Is this the way we wanna go?

comment:6 Changed 12 years ago by jari

  • Description modified (diff)

comment:7 Changed 12 years ago by jari

This is a no brainer. Natürlich!

comment:8 Changed 12 years ago by peter

Where should we place copyright statement in these wiki-pages?

In THANKS I placed the copyright statement in the bottom as verbatim. Seemed to be a good choice. But when I got to INSTALL, I realized there is problem. If we place our copyright statement in the bottom, FSF's copyright statement will be above our copyright statement. This is bad because svndigest's automatic update of copyright statement updates the first copyright statement, which means svndigest will modify FSF' scopyright statement rather than ours.

comment:9 Changed 12 years ago by peter

post-commit failed, so instead [340]

comment:10 Changed 11 years ago by jari

  • Owner set to jari
  • Status changed from new to assigned

comment:11 Changed 11 years ago by jari

(In [385]) Refs #111. Spell checked.

comment:12 Changed 11 years ago by jari

  • Resolution set to fixed
  • Status changed from assigned to closed

(In [386]) Fixes #111 and refs #202.

Note: See TracTickets for help on using tickets.