Commits

evhan  committed bfe575e

standardize formatting of "HEAD" reference in docs

  • Participants
  • Parent commits 671cfb0

Comments (0)

Files changed (1)

 <procedure>(repository-head-orphan? repositoy) => boolean</procedure>
 <procedure>(repository-head-detached? repositoy) => boolean</procedure>
 
-Returns a boolean indicating whether the given repository's HEAD (a
+Returns a boolean indicating whether the given repository's {{HEAD}} (a
 symbolic reference) is orphaned (unreferenced under the refs namespace)
 or detached (refering to a commit rather than a branch).
 
 <procedure>(reference? obj) => boolean</procedure>
 
 A {{reference}} is a direct or indirect pointer to a Git commit object. A
-repository's {{"HEAD"}} is a common example: it is a symbolic reference,
+repository's {{HEAD}} is a common example: it is a symbolic reference,
 referring to the immediate reference {{"refs/heads/master"}}, which in turn
 points at a {{commit}}.
 
 
 Returns the {{reference}} specified by the given string {{ref}} from the
 {{repository}}. {{ref}} must be a string referring to a valid reference, such
-as {{"HEAD"}}, {{"ref/heads/master"}}, or {{"refs/tags/v0.1.0"}}. An error is
+as {{HEAD}}, {{"ref/heads/master"}}, or {{"refs/tags/v0.1.0"}}. An error is
 signalled if the reference doesn't exists.
 
 <procedure>(reference-name reference) => string</procedure>
 {{#f}}, should be the {{reference}} or name of a {{reference}} that will
 be updated to point to the newly-created commit.
 
-Note that if no {{reference}} is given, the commit will be created in Git's
-database but will not be reflected in any of the repository's branches. To
-update the the working branch with the new commit, for example, use "HEAD".
+Note that if no {{reference}} is given, the commit will be created in
+Git's database but will not be reflected in any of the repository's
+branches. To update the the working branch with the new commit, for
+example, use {{"HEAD"}}.
 
 On success, the on-disk repository is updated immediately.
 
 Creates and returns a new {{tree}} object from the state of the given
 {{index}} in the given {{repository}}.
 
+If {{index}} is not given, a fresh {{index}} for the repository is used.
+This means the resulting {{tree}} will be identical to that of the
+repository's {{HEAD}}.
+
 On success, the new value is written immediately to disk.
 
 ==== Tree Entry
 Clones the remote Git repository specified by {{url}} into the local
 pathname {{path}}.
 
-On success, the branch indicated by the "HEAD" reference of the remote
+On success, the branch indicated by the {{HEAD}} reference of the remote
 repository is checked out as a normal (i.e. non-bare) Git working
 directory.