← Back to branch summary

~ubuntu-branches/ubuntu/breezy/pysvn/breezy

« back to all changes in this revision

Viewing changes to Source/pysvn_docs.hpp

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2005-09-08 05:13:33 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050908051333-qgsa2rksrb4az1h4
Tags: 1.3.0-1
Package from release tarball.

Show diffs side-by-side

added added

removed removed

Lines of Context:
Source/pysvn_docs.hpp
8
8
// ====================================================================
9
9
//
10
10
//
11
 
//      pysvn_docs.hpp
 
11
//   pysvn_docs.hpp
12
12
//
13
13
 
14
14
//--------------------------------------------------------------------------------
15
15
//
16
 
//      Doc strings
 
16
//   Doc strings
17
17
//
18
18
//--------------------------------------------------------------------------------
19
19
extern const char *copyright;
20
20
extern const char *module_doc;
21
21
extern const char *class_client_doc;
22
22
extern const char *class_revision_doc;
23
 
extern const char *class_client_doc;
24
 
extern const char *class_revision_doc;
 
23
extern const char *class_transaction_doc;
25
24
 
26
25
#define GET_AUTH_CACHE_DOC \
27
26
"enable = get_auth_cache()\n\
47
46
"is_url( path_or_url )\n\
48
47
return true if path_or_url is a SVN URL\n"
49
48
 
50
 
#define SVN_ADD_DOC \
 
49
#define PYSVN_ADD_DOC \
51
50
"add( path,\n\
52
51
     recurse=True )\n\
53
52
\n\
54
53
Schedules the file or directory specfied in path for addition to the repository.  Set recurse to True to recursively add a directory's children.\n\
55
54
Files are added at the next check in.\n"
56
 
#define SVN_ANNOTATE_DOC \
57
 
"annotation_list = annotate( path,\n\
 
55
#define PYSVN_ANNOTATE_DOC \
 
56
"annotation_list = annotate( url_or_path,\n\
58
57
     revision_start=pysvn.Revision( opt_revision_kind.number, 0 ),\n\
59
58
     revision_end=pysvn.Revision( opt_revision_kind.head ) )\n\
60
59
\n\
61
60
annotate command.\n"
62
 
#define SVN_CAT_DOC \
63
 
"cat( path,\n\
 
61
#define PYSVN_CAT_DOC \
 
62
"cat( url_or_path,\n\
64
63
     revision=pysvn.Revision( opt_revision_kind.head ) )\n\
65
64
\n\
66
65
Return the contents of path for the specified revision."
67
 
#define SVN_CHECKOUT_DOC \
 
66
#define PYSVN_CHECKOUT_DOC \
68
67
"checkout( url,\n\
69
68
          path,\n\
70
69
          recurse=True,\n\
72
71
\n\
73
72
Checkout the repository at url into the location specified by path.  Set recurse to True to recursively check out a directory's children.\n\
74
73
Specify a revision to check out a particular version of the source tree."
75
 
#define SVN_CLEANUP_DOC \
 
74
#define PYSVN_CLEANUP_DOC \
76
75
"cleanup( path )\n\
77
76
\n\
78
77
Clean up any locks in the working copy at path.  Usually such locks are the result of a failed or interrupted operation.\n"
79
 
#define SVN_CHECKIN_DOC \
 
78
#define PYSVN_CHECKIN_DOC \
80
79
"checkin( path_list,\n\
81
80
        log_message,\n\
82
81
        recurse=True )\n\
83
82
\n\
84
83
Check in the files in the path_list to the repository with the specifed log_message.  Set recurse to True to recursively check in a directory's children. with \
85
84
the same log message.\n"
86
 
#define SVN_COPY_DOC \
87
 
"copy( src_path,\n\
88
 
      dest_path,\n\
 
85
#define PYSVN_COPY_DOC \
 
86
"copy( src_url_or_path,\n\
 
87
      dest_url_or_path,\n\
89
88
      src_revision=pysvn.Revision( opt_revision_kind.head ) )\n\
90
89
\n\
91
90
Duplicate something in working copy or repos, remembering history.\n\
95
94
  WC  -> URL:  immediately check in a copy of WC to URL\n\
96
95
  URL -> WC:   check out URL into WC, schedule for addition\n\
97
96
  URL -> URL:  complete server-side copy;  used to branch & tag"
98
 
#define SVN_DIFF_DOC \
99
 
"diff( tmp_path,\n\
100
 
      path,\n\
101
 
      revision1=pysvn.Revision( opt_revision_kind.base ),\n\
102
 
      revision2=pysvn.Revision( opt_revision_kind.working ),\n\
103
 
      recurse=True,\n\
104
 
      ignore_ancestry=False,\n\
105
 
      no_diff_deleted=False )\n\
106
 
\n\
107
 
Display the differences between two paths."
108
 
#define SVN_EXPORT_DOC \
109
 
"export( src_path,\n\
 
97
#ifdef PYSVN_HAS_CLIENT_DIFF2
 
98
#define PYSVN_DIFF_DOC \
 
99
"diff( tmp_path,\n\
 
100
      url_or_path,\n\
 
101
      revision1=pysvn.Revision( opt_revision_kind.base ),\n\
 
102
      url_or_path2,\n\
 
103
      revision2=pysvn.Revision( opt_revision_kind.working ),\n\
 
104
      recurse=True,\n\
 
105
      ignore_ancestry=False,\n\
 
106
      diff_deleted=True,\n\
 
107
      ignore_content_type )\n\
 
108
\n\
 
109
Display the differences between two paths."
 
110
#else
 
111
#define PYSVN_DIFF_DOC \
 
112
"diff( tmp_path,\n\
 
113
      url_or_path,\n\
 
114
      revision1=pysvn.Revision( opt_revision_kind.base ),\n\
 
115
      url_or_path2,\n\
 
116
      revision2=pysvn.Revision( opt_revision_kind.working ),\n\
 
117
      recurse=True,\n\
 
118
      ignore_ancestry=False,\n\
 
119
      diff_deleted=True )\n\
 
120
\n\
 
121
Display the differences between two paths."
 
122
#endif
 
123
 
 
124
#ifdef PYSVN_HAS_CLIENT_EXPORT2
 
125
#define PYSVN_EXPORT_DOC \
 
126
"export( src_url_or_path,\n\
 
127
        dest_path,\n\
 
128
        force=False,\n\
 
129
        revision=pysvn.Revision( opt_revision_kind.head ),\n\
 
130
        native_eol=False )\n\
 
131
\n\
 
132
Create an unversioned copy of a tree.\n\
 
133
\n\
 
134
1. Exports a clean directory tree from the repository specified by\n\
 
135
   URL src_path, at revision if it is given, otherwise at HEAD, into\n\
 
136
   dest_path.\n\
 
137
\n\
 
138
2. Exports a clean directory tree from the working copy specified by\n\
 
139
   src_path into dest_path.  All local changes will be preserved, but files\n\
 
140
   not under revision control will not be copied."
 
141
#else
 
142
#define PYSVN_EXPORT_DOC \
 
143
"export( src_url_or_path,\n\
110
144
        dest_path,\n\
111
145
        force=False,\n\
112
146
        revision=pysvn.Revision( opt_revision_kind.head ) )\n\
120
154
2. Exports a clean directory tree from the working copy specified by\n\
121
155
   src_path into dest_path.  All local changes will be preserved, but files\n\
122
156
   not under revision control will not be copied."
123
 
#define SVN_INFO_DOC \
 
157
#endif
 
158
 
 
159
#define PYSVN_INFO_DOC \
124
160
"entry = info( path )\n\
125
161
return info on path"
126
162
 
127
 
#define SVN_IMPORT_DOC \
 
163
#ifdef PYSVN_HAS_CLIENT_INFO
 
164
#define PYSVN_INFO2_DOC \
 
165
"entry_list = \n\
 
166
info2( url_or_path,\n\
 
167
       revision=pysvn.Revision( opt_revision_kind.unspecified )\n\
 
168
       peg_revision=pysvn.Revision( opt_revision_kind.unspecified )\n\
 
169
       recurse=False )\n\
 
170
\n\
 
171
return info on url_or_path"
 
172
#else
 
173
#define PYSVN_INFO2_DOC ""
 
174
#endif
 
175
 
 
176
#define PYSVN_IMPORT_DOC \
128
177
"import_( path,\n\
129
178
        url,\n\
130
179
        log_message,\n\
135
184
Recursively check in a copy of PATH to URL.\n\
136
185
Parent directories are created as necessary in the repository."
137
186
 
138
 
#define SVN_LOG_DOC \
139
 
"log_list = log( path,\n\
 
187
 
 
188
#ifdef PYSVN_HAS_CLIENT_LOCK
 
189
#define PYSVN_LOCK_DOC \
 
190
"lock( url_or_path,\n\
 
191
      message,\n\
 
192
      force=False)\n\
 
193
Lock the url_or_path give the message as the reason. Set force True to break\n\
 
194
replace an existing lock with this one.\n\
 
195
"
 
196
#else
 
197
#define PYSVN_LOCK_DOC ""
 
198
#endif
 
199
 
 
200
#define PYSVN_LOG_DOC \
 
201
"log_list = log( url_or_path,\n\
140
202
                revision_start=pysvn.Revision( opt_revision_kind.head ),\n\
141
203
                revision_end=pysvn.Revision( opt_revision_kind.number, 0 ),\n\
142
204
                discover_changed_paths=False,\n\
146
208
If discover_changed_paths is True return the set of changed paths for each revision reported.\n\
147
209
\n\
148
210
Show the log messages for a set of revisions of path."
149
 
#define SVN_LS_DOC \
150
 
"entries_list = ls( path,\n\
 
211
 
 
212
#define PYSVN_LS_DOC \
 
213
"entries_list = ls( url_or_path,\n\
151
214
            revision=pysvn.Revision( opt_revision_kind.head ),\n\
152
215
            recurse=True )\n\
153
216
\n\
154
217
Return entries_list for the given path at the provided revision."
155
 
#define SVN_MERGE_DOC \
156
 
"merge( path1,\n\
 
218
#define PYSVN_MERGE_DOC \
 
219
"merge( url_or_path1,\n\
157
220
       revision1,\n\
158
 
       path2,\n\
 
221
       url_or_path2,\n\
159
222
       revision2,\n\
160
223
       local_path,\n\
161
224
       force=False,\n\
162
 
       recurse=True )\n\
 
225
       recurse=True,\n\
 
226
       notice_ancestry=False,\n\
 
227
       dry_run=False )\n\
163
228
\n\
164
229
Apply the differences between two sources to a working copy path."
165
230
 
166
 
#define SVN_MKDIR_DOC \
167
 
"mkdir( path,\n\
 
231
#define PYSVN_MKDIR_DOC \
 
232
"mkdir( url_or_path,\n\
168
233
       log_message )\n\
169
 
mkdir( path_list,\n\
 
234
mkdir( [url_or_path,...],\n\
170
235
       log_message )\n\
171
236
\n\
172
237
Create a new directory under revision control.\n\
180
245
immediate check in.\n\
181
246
\n\
182
247
In both cases, all the intermediate directories must already exist."
183
 
#define SVN_MOVE_DOC \
184
 
"move( src_path,\n\
185
 
      dest_path,\n\
 
248
#define PYSVN_MOVE_DOC \
 
249
"move( src_url_or_path,\n\
 
250
      dest_url_or_path,\n\
186
251
      src_revision=pysvn.Revision( opt_revision_kind.head ),\n\
187
252
      force=False )\n\
188
253
\n\
194
259
  WC  -> WC:   move and schedule for addition (with history)\n\
195
260
  URL -> URL:  complete server-side rename."
196
261
 
197
 
#define SVN_PROPLIST_DOC \
198
 
"prop_list = proplist( path,\n\
199
 
                      src_revision=pysvn.Revision( opt_revision_kind.head ),\n\
200
 
                      recurse=False )\n\
201
 
Returns a list of tuples (path, prop_dict)\n\
 
262
#define PYSVN_PROPDEL_DOC \
 
263
"rev = propdel( prop_name,\n\
 
264
         url_or_path,\n\
 
265
         revision=pysvn.Revision( opt_revision_kind.head ),\n\
 
266
         recurse=False )\n\
 
267
\n\
 
268
delete the property propname from path\n\
202
269
"
203
 
#define SVN_PROPGET_DOC \
 
270
#define PYSVN_PROPGET_DOC \
204
271
"prop_list = propget( prop_name,\n\
205
 
                      path,\n\
 
272
                      url_or_path,\n\
206
273
                      src_revision=pysvn.Revision( opt_revision_kind.head ),\n\
207
274
                      recurse=False )\n\
208
275
Returns a list of tuples (path, prop_dict)\n\
209
276
"
210
 
#define SVN_PROPSET_DOC \
211
 
"rev = propset( propname,\n\
212
 
         propval,\n\
213
 
         path,\n\
214
 
         revision=pysvn.Revision( opt_revision_kind.head ),\n\
215
 
         recurse=False )\n\
216
 
\n\
217
 
set the property propname to propval in path\n\
218
 
"
219
 
#define SVN_PROPDEL_DOC \
220
 
"rev = propdel( propname,\n\
221
 
         path,\n\
222
 
         revision=pysvn.Revision( opt_revision_kind.head ),\n\
223
 
         recurse=False )\n\
224
 
\n\
225
 
delete the property propname from path\n\
226
 
"
227
 
 
228
 
#define SVN_RELOCATE_DOC \
229
 
"relocate( path,\n\
230
 
           from_url,\n\
 
277
#define PYSVN_PROPLIST_DOC \
 
278
"prop_list = proplist( url_or_path,\n\
 
279
                      revision=pysvn.Revision( opt_revision_kind.head ),\n\
 
280
                      recurse=False )\n\
 
281
Returns a list of tuples (path, prop_dict)\n\
 
282
"
 
283
#define PYSVN_PROPSET_DOC \
 
284
"rev = propset( prop_name,\n\
 
285
         prop_value,\n\
 
286
         url_or_path,\n\
 
287
         revision=pysvn.Revision( opt_revision_kind.head ),\n\
 
288
         recurse=False )\n\
 
289
\n\
 
290
set the property prop_name to prop_value in url_or_path\n\
 
291
"
 
292
#define PYSVN_RELOCATE_DOC \
 
293
"relocate( from_url,\n\
231
294
           to_url,\n\
232
295
           path,\n\
233
296
           recurse=True)\n\
235
298
relocate the working copy from from_url to to_url of path\n\
236
299
"
237
300
 
238
 
#define SVN_REMOVE_DOC \
239
 
"remove( path_list,\n\
 
301
#define PYSVN_REMOVE_DOC \
 
302
"remove( url_or_path,\n\
 
303
        force=False )\n\
 
304
remove( [url_or_path, ...],\n\
240
305
        force=False )\n\
241
306
\n\
242
307
If run on a working copy PATHs, each item is scheduled for deletion\n\
249
314
If run on URLs, the items are deleted from the repository via an\n\
250
315
immediate check in."
251
316
 
252
 
#define SVN_RESOLVED_DOC \
 
317
#define PYSVN_RESOLVED_DOC \
253
318
"resolved( path,\n\
254
319
          recurse=True )\n\
255
320
Mark the conflicted file at path as resolved."
256
 
#define SVN_REVERT_DOC \
 
321
#define PYSVN_REVERT_DOC \
257
322
"revert( path,\n\
258
323
        recurse=False )\n\
259
324
Discard any changes in the working copy at path. Set recurse to True to recursively revert a directory's children.\n"
260
325
 
261
 
#define SVN_REVPROPDEL_DOC \
262
 
"rev = revpropdel( propname,\n\
263
 
                  path,\n\
 
326
#define PYSVN_REVPROPDEL_DOC \
 
327
"rev = revpropdel( prop_name,\n\
 
328
                  url,\n\
264
329
                  revision=pysvn.Revision( opt_revision_kind.head ),\n\
265
330
                  force=False )\n\
266
331
\n\
267
 
delete the property propname from path\n\
 
332
delete the property prop_name from url\n\
268
333
"
269
 
#define SVN_REVPROPGET_DOC \
 
334
 
 
335
#define PYSVN_REVPROPGET_DOC \
270
336
"prop_list = revpropget( prop_name,\n\
271
 
                        path,\n\
272
 
                        src_revision=pysvn.Revision( opt_revision_kind.head ) )\n\
273
 
Returns a list of tuples (path, prop_dict)\n\
274
 
"
275
 
#define SVN_REVPROPLIST_DOC \
276
 
"prop_list = revproplist( path,\n\
277
 
                         src_revision=pysvn.Revision( opt_revision_kind.head ) )\n\
278
 
Returns a list of tuples (path, prop_dict)\n\
279
 
"
280
 
#define SVN_REVPROPSET_DOC \
 
337
                        url,\n\
 
338
                        revision=pysvn.Revision( opt_revision_kind.head ) )\n\
 
339
Returns a list of tuples (path, prop_dict)\n\
 
340
"
 
341
#define PYSVN_REVPROPLIST_DOC \
 
342
"prop_list = revproplist( url,\n\
 
343
                         revision=pysvn.Revision( opt_revision_kind.head ) )\n\
 
344
Returns a list of tuples (path, prop_dict)\n\
 
345
"
 
346
#define PYSVN_REVPROPSET_DOC \
281
347
"rev = revpropset( prop_name,\n\
282
348
         prop_value,\n\
283
 
         path,\n\
 
349
         url,\n\
284
350
         revision=pysvn.Revision( opt_revision_kind.head ),\n\
285
351
         force=False )\n\
286
352
\n\
287
353
set the property propname to propval in path\n\
288
354
"
289
 
#define SVN_SINGLE_STATUS_DOC \
290
 
"path_status = single_status( path )\n\
291
 
returns status for a single file in path_status"
292
 
#define SVN_STATUS_DOC \
293
 
"path_status_list = status( path,\n\
294
 
                recurse=True,\n\
295
 
                get_all=False,\n\
296
 
                update=False,\n\
297
 
                no_ignore=False )\n\
298
 
returns status for all files in the directory path in path_status_list"
299
 
#define SVN_SWITCH_DOC \
 
355
 
 
356
 
 
357
#ifdef PYSVN_HAS_CLIENT_STATUS2
 
358
#define PYSVN_STATUS_DOC \
 
359
"path_status_list = status( path,\n\
 
360
           recurse=True,\n\
 
361
           get_all=False,\n\
 
362
           update=False,\n\
 
363
           ignore=False,\n\
 
364
           ignore_externals=False )\n\
 
365
returns status for all files in the directory path in path_status_list"
 
366
#else
 
367
#define PYSVN_STATUS_DOC \
 
368
"path_status_list = status( path,\n\
 
369
           recurse=True,\n\
 
370
           get_all=False,\n\
 
371
           update=False,\n\
 
372
           ignore=False )\n\
 
373
returns status for all files in the directory path in path_status_list"
 
374
#endif
 
375
 
 
376
#define PYSVN_SWITCH_DOC \
300
377
"switch( path,\n\
301
378
        url,\n\
302
379
        recurse=True,\n\
309
386
   Note:  this is the way to move a working copy to a new branch.\n\
310
387
\n\
311
388
2. Reconnect the working copy when the repository URL has changed."
312
 
#define SVN_UPDATE_DOC \
 
389
 
 
390
#ifdef PYSVN_HAS_CLIENT_LOCK
 
391
#define PYSVN_UNLOCK_DOC \
 
392
"unlock( url_or_path,\n\
 
393
        force=False)\n\
 
394
Unlock the url_or_path. Set force True to break\n\
 
395
unlock an existing lock.\n\
 
396
"
 
397
#else
 
398
#define PYSVN_UNLOCK_DOC ""
 
399
#endif
 
400
 
 
401
 
 
402
#define PYSVN_UPDATE_DOC \
313
403
"revision = \\\n\
314
404
update( path,\n\
315
405
        recurse=True,\n\
320
410
current revision.  To make the current version identical to an older revision, use a merge followed by a check in.\n\
321
411
update returns a pysvn.Revision containing the number of the revision the working copy was updated to."
322
412
 
 
413
 
 
414
 
 
415
//
 
416
// Transaction docs
 
417
//
 
418
#define TXN_CAT_DOC \
 
419
"x = cat( path )\n\
 
420
\n\
 
421
TBD\n\
 
422
"
 
423
 
 
424
#define TXN_CHANGED_DOC \
 
425
"x = changed()\n\
 
426
\n\
 
427
TBD\n\
 
428
"
 
429
 
 
430
#define TXN_DIFF_DOC \
 
431
"x = diff( path )\n\
 
432
\n\
 
433
TBD\n\
 
434
"
 
435
 
 
436
#define TXN_PROPDEL_DOC \
 
437
"propdel( prop_name )\n\
 
438
\n\
 
439
delete the property prop_name from the transaction\n\
 
440
"
 
441
#define TXN_PROPGET_DOC \
 
442
"prop_value = propget( prop_name )\n\
 
443
\n\
 
444
Returns the prop_value string for prop_name in the transaction\n\
 
445
"
 
446
#define TXN_PROPLIST_DOC \
 
447
"prop_dict = proplist()\n\
 
448
\n\
 
449
Returns a dict with all the properties in the transaction\n\
 
450
"
 
451
#define TXN_PROPSET_DOC \
 
452
"propset( prop_name,\n\
 
453
          prop_value )\n\
 
454
\n\
 
455
set the property prop_name to prop_value in the transaction\n\
 
456
"
 
457
 
 
458
#define TXN_REVPROPDEL_DOC \
 
459
"revpropdel( prop_name )\n\
 
460
\n\
 
461
delete the revproperty prop_name from the transaction\n\
 
462
"
 
463
#define TXN_REVPROPGET_DOC \
 
464
"prop_value = revpropget( prop_name )\n\
 
465
\n\
 
466
Returns the prop_value string for prop_name in the transaction\n\
 
467
"
 
468
#define TXN_REVPROPLIST_DOC \
 
469
"revprop_dict = revproplist()\n\
 
470
\n\
 
471
Returns a dict with all the revproperties in the transaction\n\
 
472
"
 
473
#define TXN_REVPROPSET_DOC \
 
474
"revpropset( prop_name,\n\
 
475
          prop_value )\n\
 
476
\n\
 
477
set the revproperty prop_name to prop_value in the transaction\n\
 
478
"