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

Re: [PATCH] Fix documentation link for svn_dirent_t

From: Ben Reser <ben_at_reser.org>
Date: 2004-01-06 05:17:45 CET

On Thu, Jan 01, 2004 at 08:51:56PM -0500, Greg Hudson wrote:
> On Thu, 2004-01-01 at 20:25, Ben Reser wrote:
> > [[[
> > * subversion/include/svn_types.h
> > Remove svn_dirent that was causing doxygen not to link svn_dirent_t
> > to the documentation for the svn_dirent_t struct.
> > ]]]
>
> Did you check our other struct declarations? We almost always give the
> struct a tag with the same name as the typedef. Giving the structure a
> tag seems to be helpful when probing around with gdb.

Okay I'm attaching two variations on this patch. One is a pretty
complete set of changes to fix tagging and formatting of structs to be
consistent throughout the headers. The other one is a minimal patch.
The minimal patch only fixes the svn_dirent_t tagging and the
svn_error_t tagging. The svn_dirent_t patch causes missing links in the
documentation. The svn_error_t tagging creates a problem for the perl
bindings. It causes the child member of the svn_error_t struct to show
as a _p_svn_error which breaks method access to it (and also breaks my
new error handling setup which will be coming along as a separate patch
soon). So at least the minimal patch is necessary, but the more
extensive patch might be nice.

I'll point out that we're not following GNU style on the struct
definitions. Which says:
"Don't declare both a structure tag and variables or typedefs in the
same declaration. Instead, declare the structure tag separately and then
use it to declare the variables or typedefs." [1]

I have no idea why they decided that, but I did not change to follow
their style. But I mention it because it may be useful to add something
to HACKING to specify which style we prefer here since we're doing
something different than the GNU standard.

[1] http://www.gnu.org/prep/standards_25.html#SEC25

Log for big patch:
[[[
* subversion/include/svn_fs.h
* subversion/include/svn_sorts.h
* subversion/include/svn_ra_svn.h
* subversion/include/svn_delta.h
* subversion/include/svn_types.h
* subversion/include/svn_string.h
* subversion/include/svn_auth.h
* subversion/include/svn_opt.h
  Fix a variety of struct formating and tagging issues.
]]]

Log for minimal patch:
[[[
* subversion/include/svn_types.h
  Use the same tag for the svn_dirent_t and svn_error_t as the typedef
  name.
]]]

-- 
Ben Reser <ben@reser.org>
http://ben.reser.org
"Conscience is the inner voice which warns us somebody may be looking."
- H.L. Mencken



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org

Received on Tue Jan 6 05:18:17 2004

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