[libgit2-glib] Improved documentation for getting head

[Jesse van den Kieboom <jessevdk src gnome org>]

commit 284d3f69e859a96cd24eb0cc6f5e209fd5d539a1
Author: Jesse van den Kieboom <jessevdk gmail com>
Date:   Fri Jul 5 15:43:04 2013 +0200

    Improved documentation for getting head

 libgit2-glib/ggit-repository.c |    5 ++++-
 1 files changed, 4 insertions(+), 1 deletions(-)
---
diff --git a/libgit2-glib/ggit-repository.c b/libgit2-glib/ggit-repository.c
index 668baa5..6153b7e 100644
--- a/libgit2-glib/ggit-repository.c
+++ b/libgit2-glib/ggit-repository.c
@@ -723,7 +723,10 @@ ggit_repository_create_symbolic_reference (GgitRepository  *repository,
  * @repository: a #GgitRepository.
  * @error: a #GError for error reporting, or %NULL.
  *
- * Get the current HEAD reference of the repository.
+ * Get and resolves the current HEAD reference of the repository. Note that the
+ * returned ref is already resolved (if HEAD is symbolic). If you want to
+ * retrieve the symbolic ref called HEAD, then use #ggit_repository_lookup_reference
+ * instead.
  *
  * Returns: (transfer full): a #GgitRef
  *