[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: Advice on maintaining doc dir

From: Ulrich Eckhardt <eckhardt_at_satorlaser.com>
Date: 2005-01-14 10:57:13 CET

Nick_Gianakas@sybari.com wrote:
> We use Doxygen to generate documentation from our software, and then
> commit it to our repo.
> Does anyone have any suggestions on how to do this efficiently. Here's
> the situation:
>
> This is the ideal procedure:
> 1. Change code w/ documentation
> 2. Run Doxygen
> 3. Commit changes
>
> This is the actual procedure:
> 1. Change code w/ documentation
> 2. svn delete (but don't commit) all files in doc dir
> 3. Run Doxygen (placing new files in doc dir)
> 4. svn add all files currently in dir (ignore warnings about files
> already in repo)
> 5. svn revert all files currently in dir
>
> The reason for this is to handle cases that doc files have been added or
> deleted.
>
> Is there a simpler way?

Yes, it's even part of subversion: svn_load_dirs, a Python script that is
mainly used for tracking third-party sources.

About the concerns of Jeremy about versioning generated files, I must say I
agree. We put doxymentation on a central server here at work, which is IHMO
sufficient. Still, even if your case is different, you might consider using a
different repository and svn:externals to link the docs into the WCs. If I
were you, I'd prefer that in order to keep generated and self-written stuff
separated. However, YMMV.

cheers

Uli

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@subversion.tigris.org
For additional commands, e-mail: users-help@subversion.tigris.org
Received on Fri Jan 14 10:58:20 2005

This is an archived mail posted to the Subversion Users mailing list.