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

A clean-up task: delete "Use scratch_pool for temporary allocations" from doc strings

From: Julian Foad <julianfoad_at_btopenworld.com>
Date: Wed, 30 Jan 2013 17:09:27 +0000 (GMT)

No particular time frame, but a little clean-up task for
anybody who has a touch of OCD or likes
playing with regular expression search and replace, would be to remove
the clause"Use scratch_pool for temporary allocations" from all our doc strings.
Documentation should be helpful and concise; repeating universal truths is neither.  Our 'scratch_pool' convention is universal.  Not all code uses the convention, but it always means the same thing when it is used.

(The 'result_pool' convention, on the other hand, is a bit more involved.  Results are not always allocated in result_pool, and there are often conditions attached such as "except some of the values in the result structure are shallow-copied from the inputs".  So the public APIs at least should probably always be explicit about use of the result pool.)

- Julian

Certified & Supported Apache Subversion Downloads: http://www.wandisco.com/subversion/download
Received on 2013-01-30 18:10:02 CET

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

This site is subject to the Apache Privacy Policy and the Apache Public Forum Archive Policy.