S.Ramaswamy wrote:
>
>> If log2 depends on "unspecified" having a particular meaning in
>>log3, then either that meaning must be documented publically for log3 or it is
>>an implementation detail that shouldn't be mentioned publically for log2. In
>>the former case, it would be fine for log2 to be described in terms of what
>>value it passes to log3; in the latter case, log2 would have to be described in
>>terms of its effect rather than that value which would be an implementation detail.
>
> Ok, I could expand the doc string for svn_client_log3(), to include:
>
> * @a peg_revision indicates in
> * which revision @a path_or_url is valid. If @a peg_revision is @c
> * svn_opt_revision_unspecified, then it defaults to @c
> * svn_opt_revision_head for URLs or @c svn_opt_revision_working for
> * WC targets.
>
> and the doc string for svn_client_log() would remain the same:
OK.
> Note that svn_client_checkout2(), svn_client_checkout have similar doc
> strings w.r.t peg revision.
Oh yes. And svn_client_export3(). And the private function
svn_client__ra_session_from_path() which ultimately handles the peg revision in
that way for those two and many other higher-level functions.
I have updated the doc strings for all three of those in r16034.
- Julian
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Sat Sep 3 16:05:19 2005