Commits

evhan  committed c8f0dd3

Minor doc formatting changes

  • Participants
  • Parent commits dfeec79

Comments (0)

Files changed (1)

 
 A {{repository}} corresponds to an on-disk Git repository.
 
-<procedure>(create-repository [path] [bare]) => repository</procedure>
+<procedure>(create-repository [path [bare]]) => repository</procedure>
 
 Creates & returns a new repository at the given {{path}}, or the value of
 {{current-directory}} if no path is given. If {{bare}} is given and not {{#f}},
 signalled if the reference doesn't exists.
 
 <procedure>(reference-name reference) => string</procedure>
-<procedure>(reference-id reference) => oid</procedure>
 
-Returns the name of the given {{reference}} and the {{oid}} of the
-object referred to by the given {{reference}}, respectively.
+Returns the name of the given {{reference}}.
 
 <procedure>(reference-type reference) => symbol</procedure>
 
 Returns the type symbol of the given {{reference}}, which will be either
-{{'oid}} or {{'symbolic}}.
+{{oid}} or {{symbolic}}.
 
 <procedure>(reference-remote? reference) => boolean</procedure>
 <procedure>(reference-branch? reference) => boolean</procedure>
 Folds over the given {{repository}}'s references in unspecified order.
 
 An optional {{type}} symbol may be provided to limit the types of
-references returnd, and may be one of the symbols {{'oid}},
-{{'symbolic}}, or {{'all}}. If no {{type}} is given, {{'all}} is used.
+references returnd, and may be one of the symbols {{oid}},
+{{symbolic}}, or {{all}}. If no {{type}} is given, {{all}} is used.
 
 <procedure>(references repository [type]) => list</procedure>
 
 returning a new non-symbolic {{reference}} pointing refering directly to
 an {{oid}}.
 
-<procedure>(reference-target reference) => string</procedure>
+<procedure>(reference-target reference) => oid</procedure>
 
-Returns the {{oid}} or {{reference}} to which the given {{reference}}
-refers.
+Returns the {{oid}} of the object which the given {{reference}} refers.
+Symbolic references are peeled until a non-symbolic reference is found,
+as with {{reference-resolve}}.
 
 <procedure>(reference-rename reference name [force]) => reference</procedure>
 <procedure>(reference-target-set! reference target) => void</procedure>
 
 Folds over the given {{repository}}'s branches in unspecified order.
 
-A {{type}} symbol may be given, either {{'local}}, {{'remote}}, or
-{{'all}}, to specify what type of branches should be listed; by default,
-{{'all}} is used.
+A {{type}} symbol may be given, either {{local}}, {{remote}}, or
+{{all}}, to specify what type of branches should be listed; by default,
+{{all}} is used.
 
 <procedure>(branches repository [type]) => list</procedure>
 
 SHA1 is given, only commits that are ancestors of that revision will be
 returned. If a list of revisions to {{hide}} is given, they and their ancestors
 will be ignored. If a {{sort}} is specified, commits will be collected in the
-given order; this sort order must be one of the symbols {{'none}}, {{'topo}},
-{{'time}} or {{'reverse}}.
+given order; this sort order must be one of the symbols {{none}}, {{topo}},
+{{time}} or {{reverse}}.
 
 <procedure>(commits repository #!rest args) => list</procedure>
 
 <procedure>(tag-type tag) => symbol</procedure>
 
 Returns the object type symbol of the target of the given {{tag}}, which will
-be one of {{'commit}}, {{'tree}}, {{'blob}}, or {{'tag}}.
+be one of {{commit}}, {{tree}}, {{blob}}, or {{tag}}.
 
 <procedure>(tag-name tag) => string</procedure>
 <procedure>(tag-message tag) => string</procedure>
 
 <procedure>(tree-entry-type tree-entry) => symbol</procedure>
 
-Returns the object type symbol, either {{'tree}} or {{'blob}}, of the given
+Returns the object type symbol, either {{tree}} or {{blob}}, of the given
 {{tree-entry}}.
 
 <procedure>(tree-entry->object [repository] tree-entry) => object</procedure>
 
 Returns the {{index-entry}} from the {{index}} for the given {{key}}, which may
 be an zero-based integer index or a pathname string, or {{#f}} if no such entry
-exists. If a type symbol is given, either {{'merged}} (the default behavior) or
-{{'unmerged}}, the search will be limited to such entries.
+exists. If a type symbol is given, either {{merged}} (the default behavior) or
+{{unmerged}}, the search will be limited to such entries.
 
 ==== Index Entry
 
 
 Writes a given data {{blob}} to the {{odb}}, returning an {{oid}} referring to
 the newly-created object. The type of the stored data can be specified by an
-optional {{type}} symbol, which defaults to {{'blob}}.
+optional {{type}} symbol, which defaults to {{blob}}.
 
 <procedure>(odb-hash odb data [type]) => oid</procedure>
 
 Returns an {{oid}} reference for the given data {{blob}} as though it had been
 stored to the given {{odb}} but without writing it to disk. The type of the
 hashed data can be specified by an optional {{type}} symbol, which defaults to
-{{'blob}}.
+{{blob}}.
 
 ==== ODB Object
 
 <procedure>(config-path [type]) => string</procedure>
 
 Returns the path to a Git configuration file, if one exists. {{type}}
-may be a symbol specifying the type of path to search, either {{'user}},
-{{'system}} or {{'xdg}}, to request the path to the configuration for
+may be a symbol specifying the type of path to search, either {{user}},
+{{system}} or {{xdg}}, to request the path to the configuration for
 the current user, the system-wide Git installation, or the configuration
 file path specified by the XDG standard (".config/git/config"),
-respectively. {{type}} defaults to {{'user}}. An error is signalled if
+respectively. {{type}} defaults to {{user}}. An error is signalled if
 no configuration file is found at the requested location.
 
 <procedure>(config-open [source]) => config</procedure>
 Returns the value of the property {{name}} in the given {{config}}
 object. The value is returned as a string, unless an alternative return
 type is specified by the given symbol {{type}}, which should be
-{{'string}}, {{'symbol}}, {{'number}} or {{'boolean}}. An error is
+{{string}}, {{symbol}}, {{number}} or {{boolean}}. An error is
 signaled if the requested property doesn't exist, or if it cannot be
 converted to the specified return type.