Changeset 32828 in project


Ignore:
Timestamp:
10/17/15 06:38:16 (4 years ago)
Author:
evhan
Message:

wiki/git: Update version history

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/git

    r32626 r32828  
    55[[toc:]]
    66
    7 === Description
    8 
    9 Bindings to the [[http://libgit2.github.com|libgit2]] library.
     7== Description
     8
     9A Git interface based on the [[http://libgit2.github.com|libgit2]]
     10library.
    1011
    1112The current version of this extension requires libgit2 0.22.0 and
    1213Chicken 4.8.0 or newer. Refer to the [[#history|version history table]]
    13 to see which extensions versions support older libgit2 releases.
     14to see which versions support older libgit2 releases.
    1415
    1516The source for this egg is available at
    1617[[https://bitbucket.org/evhan/chicken-git]].
    1718
    18 === Documentation
    19 
    20 {{git}} provides an interface for reading & manipulating git repositories.
    21 The library is split into two modules, {{git}} and {{libgit2}}:
    22 
    23 * {{libgit2}} is essentially just the libgit2 API, thinly wrapped. Most of
    24   the function signatures remain the same, with a few exceptions:
     19== Documentation
     20
     21{{git}} provides an interface for reading and manipulating git
     22repositories. The library is split into two modules, {{git}} and
     23{{libgit2}}:
     24
     25* {{libgit2}} is just the libgit2 API, thinly wrapped. Most of the
     26  function signatures remain the same, with a few exceptions:
    2527
    2628** Memory for out parameters and other structures that would typically
    27 go on the stack is allocated automatically.
    28 
    29 ** Return values are checked where appropriate, signaling an exception of type
    30 {{git}} when nonzero.
     29   go on the stack is allocated automatically.
     30
     31** Return values are checked where appropriate, signaling an exception
     32   of type {{git}} when nonzero.
    3133
    3234* {{git}} is a higher-level interface around {{libgit2}}, providing
    3335  record types for each libgit2 structure.
    3436
    35 === Usage
     37== Usage
    3638
    3739  (use git) ; or...
     
    4345The following documentation applies to the {{git}} module.
    4446
    45 === API
    46 
    47 ==== Repository
     47== API
     48
     49=== Repository
    4850
    4951<record>repository</record>
     
    5456<procedure>(create-repository [path [bare]]) => repository</procedure>
    5557
    56 Creates & returns a new repository at the given {{path}}, or the value of
     58Creates and returns a new repository at the given {{path}}, or the value of
    5759{{current-directory}} if no path is given. If {{bare}} is given and not {{#f}},
    5860the repository will be created without a working directory. An error is
     
    100102created, respectively.
    101103
    102 ==== OID
     104=== OID
    103105
    104106<record>oid</record>
     
    127129Indicates whether the two {{oid}}s are the equivalent.
    128130
    129 ==== Revspec
     131=== Revspec
    130132
    131133<procedure>(parse-revision-specification string) => (values object object)</procedure>
     
    134136two values:
    135137
    136 * If {{string}} specifies a range of revisions, the start & end
     138* If {{string}} specifies a range of revisions, the start and end
    137139  {{commit}} objects.
    138140* If {{string}} specifies a single revision, the {{commit}} object and
     
    144146[[http://git-scm.com/docs/git-rev-parse.html#_specifying_revisions]].
    145147
    146 ==== Reference
     148=== Reference
    147149
    148150<record>reference</record>
     
    231233<procedure>(create-reference repository #!key name target [symbolic] [force]) => reference</procedure>
    232234
    233 Creates & returns a new reference in the given {{repository}} for the specified
     235Creates and returns a new reference in the given {{repository}} for the specified
    234236{{name}} and {{target}}. If {{symbolic}} is given and not {{#f}}, the created
    235237reference will be so, and {{target}} must be a reference name or {{reference}}.
     
    247249On success, the on-disk repository is updated immediately.
    248250
    249 ==== Branch
     251=== Branch
    250252
    251253<procedure>(create-branch repository name target [force]) => reference</procedure>
     
    309311On success, the on-disk repository is updated immediately.
    310312
    311 ==== Generic Procedures
     313=== Generic Procedures
    312314
    313315These procedures can be used on any objects of the four main Git object
     
    336338{{tree}}, {{tag}} or {{blob}}.
    337339
    338 ==== Blob
     340=== Blob
    339341
    340342<record>blob</record>
     
    381383On success, the on-disk repository is updated immediately.
    382384
    383 ==== Commit
     385=== Commit
    384386
    385387<record>commit</record>
     
    471473<procedure>(create-commit repository #!key message author [committer] [tree] [parents] [reference]) => commit</procedure>
    472474
    473 Creates & returns a new commit in the given {{repository}}. The string
     475Creates and returns a new commit in the given {{repository}}. The string
    474476{{message}} will be used as the commit's message and {{tree}} will be
    475477the file tree of the commit. If no {{tree}} is given, the current state
     
    493495{{commit2}} may be {{commit}}s, commit {{oid}}s, or SHA1 hashes.
    494496
    495 ==== Tag
     497=== Tag
    496498
    497499<record>tag</record>
     
    503505<procedure>(tag repository ref) => tag</procedure>
    504506
    505 Creates & returns the {{tag}} specified by the given {{ref}} from the
     507Creates and returns the {{tag}} specified by the given {{ref}} from the
    506508repository. {{ref}} may be a SHA1 string, {{oid}}, or {{tag}}. An error is
    507509signaled if no such {{tag}} exists.
     
    556558<procedure>(create-tag repository #!key target name message tagger [force]) => tag</procedure>
    557559
    558 Creates & returns a new tag in the given {{repository}} for the specified
     560Creates and returns a new tag in the given {{repository}} for the specified
    559561{{name}}, {{message}} and {{target}}. {{name}} and {{message}} must be strings,
    560562{{tagger}} must be a {{signature}},and {{target}} must be a {{commit}},
     
    565567On success, the on-disk repository is updated immediately.
    566568
    567 ==== Tree
     569=== Tree
    568570
    569571<record>tree</record>
     
    623625On success, the new value is written immediately to disk.
    624626
    625 ==== Tree Entry
     627=== Tree Entry
    626628
    627629<record>tree-entry</record>
     
    657659{{tree-builder}}, instead, an error will be signaled.
    658660
    659 ==== Tree Builder
     661=== Tree Builder
    660662
    661663<record>tree-builder</record>
     
    697699Removes all objects from the given {{tree-builder}}.
    698700
    699 ==== Diff
     701=== Diff
    700702
    701703<record>diff</record>
     
    821823{{diff-line-origin}}, one of {{#\+}}, {{#\-}} or {{#\space}}.
    822824
    823 ==== Patch
     825=== Patch
    824826
    825827<record>patch</record>
     
    843845patch.
    844846
    845 ==== Status
     847=== Status
    846848
    847849<procedure>(file-status repository path) => symbol</procedure>
     
    883885ignored by Git or not.
    884886
    885 ==== Ignore
     887=== Ignore
    886888
    887889<procedure>(path-ignored? repository path) => boolean</procedure>
     
    903905{{ignore-add!}}.
    904906
    905 ==== Note
     907=== Note
    906908
    907909<record>note</record>
     
    937939<procedure>(create-note repository #!key message target reference author [committer] [force]) => note</procedure>
    938940
    939 Creates & returns a new {{note}} in the given {{repository}} with the
     941Creates and returns a new {{note}} in the given {{repository}} with the
    940942specified {{message}} and {{target}} object. {{author}} and
    941943{{committer}} should be {{signature}}s, while {{reference}} may specify
     
    963965which defaults to {{"refs/notes/commits"}}.
    964966
    965 ==== Index
     967=== Index
    966968
    967969<record>index</record>
     
    10231025{{unmerged}}, the search will be limited to such entries.
    10241026
    1025 ==== Index Entry
     1027=== Index Entry
    10261028
    10271029<record>index-entry</record>
     
    10551057exists in its in-memory {{index}}.
    10561058
    1057 ==== ODB
     1059=== ODB
    10581060
    10591061<record>odb</record>
     
    10941096{{blob}}.
    10951097
    1096 ==== ODB Object
     1098=== ODB Object
    10971099
    10981100<record>odb-object</record>
     
    11171119Returns a blob consisting of the {{odb-object}}'s data.
    11181120
    1119 ==== Signature
     1121=== Signature
    11201122
    11211123<record>signature</record>
     
    11471149given {{signature}} and its UTC offset in minutes, respectively.
    11481150
    1149 ==== Checkout
     1151=== Checkout
    11501152
    11511153<procedure>(checkout repository [object]) => void</procedure>
     
    11681170directory.
    11691171
    1170 ==== Clone
     1172=== Clone
    11711173
    11721174<procedure>(clone url path) => void</procedure>
     
    11811183An error is signaled if the clone fails for any reason.
    11821184
    1183 ==== Config
     1185=== Remote
     1186
     1187<record>remote</record>
     1188<procedure>(remote? obj) => boolean</procedure>
     1189
     1190A {{remote}} represents a remote repository.
     1191
     1192<procedure>(remote-name remote) => string</procedure>
     1193<procedure>(remote-name-set! remote name) => void</procedure>
     1194
     1195{{remote-name}} returns the name of the given {{remote}}, for example
     1196{{"origin"}}.
     1197
     1198{{remote-name-set!}} changes the name of the given {{remote}} to the
     1199string {{name}}.
     1200
     1201On success, the on-disk repository is updated immediately.
     1202
     1203<procedure>(remote repository name) => remote</procedure>
     1204
     1205Retrieves the {{remote}} of the given {{name}} from the {{repository}}.
     1206An error is signaled if no such remote exists.
     1207
     1208<procedure>(remotes repository) => (list-of remote)</procedure>
     1209
     1210Returns a list of all {{remote}}s in the given {{repository}}.
     1211
     1212=== Config
    11841213
    11851214<record>config</record>
     
    12271256On success, the change is written immediately to disk.
    12281257
    1229 === History
    1230 
     1258== History
     1259
     1260; 0.0.32 : libgit2 0.22.0 - support THREADSAFE=1 libgit2 builds
    12311261; 0.0.31 : libgit2 0.22.0
    12321262; 0.0.30 : libgit2 0.21.0
     
    12391269; 0.0.23 : libgit2 0.19.0 - object owner tracking
    12401270; 0.0.22 : libgit2 0.19.0 - note, clone & revparse bindings
    1241 ; 0.0.21 : libgit2 0.19.0 - fix for repository-ref on 32-bit platforms
    1242 ; 0.0.20 : libgit2 0.19.0
    1243 
    1244 === Author
     1271; 0.0.21 : libgit2 0.19.0
     1272
     1273== Author
    12451274
    12461275Evan Hanson
    12471276
    1248 === License
     1277== License
    12491278
    12501279Copyright (c) 2013-2015, Evan Hanson, 3-Clause BSD License
Note: See TracChangeset for help on using the changeset viewer.