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

Re: [PATCH] docco on WC-DB abspath conventions

From: Julian Foad <julian.foad_at_wandisco.com>
Date: Thu, 28 Jan 2010 17:06:01 +0000

And another similar patch. I'll paste this one in-line just to make sure
you can read it easily.

* subversion/libsvn_wc/wc_db.h
  Document the conventions about parameter order at the top of the file.
  Remove a "###" comment about this.

[[[
Index: subversion/libsvn_wc/wc_db.h
===================================================================
--- subversion/libsvn_wc/wc_db.h (revision 904098)
+++ subversion/libsvn_wc/wc_db.h (working copy)
@@ -77,7 +77,15 @@
    resulting impact on memory consumption (which should still be minimal).

- PARAMETER NAMING
+ PARAMETER CONVENTIONS
+
+ * Parameter Order
+ - any output arguments
+ - DB
+ - LOCAL_ABSPATH
+ - any other input arguments
+ - RESULT_POOL
+ - SCRATCH_POOL

    * DB
      This parameter is the primary context for all operations on the
@@ -1222,15 +1218,6 @@
    ### original_uuid will be NULL
    ### original_revision will be SVN_INVALID_REVNUM
 
- ### KFF: The position of 'db' in the parameter list is sort of
- ### floating around (e.g., compare this func with the next one).
- ### Would be nice to keep it consistent. For example, it always
- ### comes first, or always comes first after any result params, or
- ### whatever.
- ### BH: 'db' is the first argument after the output arguments, the next
- ### is always 'local_abspath'. Next are other input arguments. Result
- ### and scratch pool are last.
-
    ### note that @a base_shadowed can be derived. if the status specifies
    ### an add/copy/move *and* there is a corresponding node in BASE, then
    ### the BASE has been deleted to open the way for this node.
]]]

I'll commit these two (probably combined as one) tomorrow if no
objections.

- Julian

Received on 2010-01-28 18:06:39 CET

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