Re: [PATCH] notes/releases.txt

In a message dated: 15 Jul 2003 19:37:51 CDT
kfogel@collab.net said:

>Paul, I think you're trying to tune the docs so they're optimized for
>release management.

I don't think that's the case, but it seems to be the perception I'm
giving everyone :) In my mind, I'm trying to tune the docs so that
essential information is quickly and easily obtained, and centralized
in as few locations as possible. But, if that's not desirable, I'm
very good at not doing things :)

>The INSTALL file is very easy to complain about, but not so easy to
>improve. Writing documentation is hard.

I agree with that wholeheartedly!

Now, on to something completely different, yet related...

You said at some point:

   kfogel> Don't say how to build Subversion, INSTALL already says it :-).

   pll> c) make
   pll> d) make check
   pll> - e) (start up Apache for testing, then) make davcheck
   pll> - f) (start up svnserve for testing, then) make svncheck
   pll> - g) subversion/clients/cmdline/svn co http://svn.collab.net/repos/svn/trunk
   pll> + e) make install (this activates mod_dav)
   pll> + e) make davcheck

   kfogel> Likewise, more or less.

I take that to mean that 'make check', and running the other tests are,
more or less, documented elsewhere. INSTALL mentions 'make check' and
'make install', but has no further comment other than to list them
as I did above.

'make davcheck' isn't mentioned anywhere else but releases.txt AFAICT.

At some point, there seemed to be a concensus for a TESTING file,
outlining how to test Subversion (did I misinterpret this?).

So, I went looking at subversion/tests/README and
subversion/tests/clients/cmdline/README. Interestingly, neither one
really seems to be about how to test subversion. They both seem to be
more about how to write tests than actually running tests; the first
in C and the second in Python, which then references the first.
(though, the C doc outlines the correct UI for tests, and the
Python doc gives some good examples of the UI in action).

Should these documents be combined into a more general TESTING
document with sections for "Running Tests" and "Writing Tests"?

(again, I'm good at not doing stuff, so, if this too is undesirable,
just say so, and I'll leave them alone :)

-- 
Seeya,
Paul
--
Key fingerprint = 1660 FECC 5D21 D286 F853  E808 BB07 9239 53F1 28EE
	It may look like I'm just sitting here doing nothing,
   but I'm really actively waiting for all my problems to go away.
	 If you're not having fun, you're not doing it right!
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org