Minor updates

Author: p-ranav

README.md

@@ -1233,8 +1233,8 @@ The project is available under the [MIT](https://opensource.org/licenses/MIT) li
 | --- | --- |
 | `git_remote_add_fetch` | `repository::add_fetch_refspec_to_remote` |
 | `git_remote_add_push` | `repository::add_push_refspec_to_remote` |
-| `git_remote_autotag` | |
-| `git_remote_connect` | |
+| `git_remote_autotag` | **Not Implemented** |
+| `git_remote_connect` | **Not Implemented** |
 | `git_remote_connected` | `remote::is_connected` |
 | `git_remote_create` | `repository::create_remote` |
 | `git_remote_create_anonymous` | `repository::create_anonymous_remote` |
@@ -1256,10 +1256,10 @@ The project is available under the [MIT](https://opensource.org/licenses/MIT) li
 | `git_remote_is_valid_name` | `remote::is_valid_name` |
 | `git_remote_list` | `repository::remote_list` |
 | `git_remote_lookup` | `repository::lookup_remote` |
-| `git_remote_ls` | |
+| `git_remote_ls` | **Not Implemented** |
 | `git_remote_name` | `remote::name` |
 | `git_remote_owner` | `remote::owner` |
-| `git_remote_prune` | |
+| `git_remote_prune` | **Not Implemented** |
 | `git_remote_prune_refs` | `remote::prune_references` |
 | `git_remote_push` | `remote::push` |
 | `git_remote_pushurl` | `remote::push_url` |

include/cppgit2/odb.hpp

@@ -50,12 +50,14 @@ class odb : public libgit2_api {
   void add_alternate_backend(const backend &backend, int priority);
 
   // Add a custom backend to an existing Object DB
-  // The backends are checked in relative ordering, based on the value of the priority parameter.
+  // The backends are checked in relative ordering, based on the value of the
+  // priority parameter.
   void add_backend(const backend &backend, int priority);
 
   // Add an on-disk alternate to an existing Object DB.
-  // Note that the added path must point to an objects, not to a full repository, to use it as an alternate store.
-  // Alternate backends are always checked for objects after all the main backends have been exhausted.
+  // Note that the added path must point to an objects, not to a full
+  // repository, to use it as an alternate store. Alternate backends are always
+  // checked for objects after all the main backends have been exhausted.
   // Writing is disabled on alternate backends.
   void add_disk_alternate_backend(const std::string &path);
 

include/cppgit2/remote.hpp

@@ -42,8 +42,8 @@ class remote : public libgit2_api {
   class create_options : public libgit2_api {
   public:
     create_options() : c_ptr_(nullptr) {
-      auto ret =
-          git_remote_create_init_options(&default_options_, GIT_REMOTE_CREATE_OPTIONS_VERSION);
+      auto ret = git_remote_create_init_options(
+          &default_options_, GIT_REMOTE_CREATE_OPTIONS_VERSION);
       c_ptr_ = &default_options_;
       if (ret != 0)
         throw git_exception();
@@ -60,15 +60,23 @@ class remote : public libgit2_api {
     void set_repository(const class repository &repo);
 
     // Name
-    std::string name() const { return c_ptr_->name ? std::string(c_ptr_->name) : ""; }
+    std::string name() const {
+      return c_ptr_->name ? std::string(c_ptr_->name) : "";
+    }
     void set_name(const std::string &name) { c_ptr_->name = name.c_str(); }
 
     // Fetchspec
-    std::string fetchspec() const { return c_ptr_->fetchspec ? std::string(c_ptr_->fetchspec) : ""; }
-    void set_fetchspec(const std::string &fetchspec) { c_ptr_->fetchspec = fetchspec.c_str(); }
+    std::string fetchspec() const {
+      return c_ptr_->fetchspec ? std::string(c_ptr_->fetchspec) : "";
+    }
+    void set_fetchspec(const std::string &fetchspec) {
+      c_ptr_->fetchspec = fetchspec.c_str();
+    }
 
     // Flags
-    create_flag flags() const { return static_cast<create_flag>(c_ptr_->flags); }
+    create_flag flags() const {
+      return static_cast<create_flag>(c_ptr_->flags);
+    }
     void set_flags(const create_flag &flags) {
       c_ptr_->flags = static_cast<unsigned int>(flags);
     }
@@ -96,8 +104,8 @@ class remote : public libgit2_api {
 
   // Create a remote, with options.
   // This function allows more fine-grained control over the remote creation.
-  static remote create_remote(const std::string &url, 
-    const create_options &options = create_options());
+  static remote create_remote(const std::string &url,
+                              const create_options &options = create_options());
 
   // Retrieve the name of the remote's default branch
   // This function must only be called after connecting.
@@ -118,6 +126,33 @@ class remote : public libgit2_api {
   // The memory is owned by the user and should be freed
   strarray fetch_refspec() const;
 
+  // Description of a reference advertised by a remote server, given out on `ls`
+  // calls.
+  class head : public libgit2_api {
+  public:
+    head(const git_remote_head *c_ptr) : c_struct_(*c_ptr) {}
+
+    bool local() const { return c_struct_.local; }
+
+    oid id() const { return oid(&c_struct_.oid); }
+
+    oid lid() const { return oid(&c_struct_.loid); }
+
+    std::string name() const {
+      return c_struct_.name ? std::string(c_struct_.name) : "";
+    }
+
+    // If the server send a symref mapping for this ref, this will point to the
+    // target.
+    std::string symref_target() const {
+      return c_struct_.symref_target ? std::string(c_struct_.symref_target)
+                                     : "";
+    }
+
+  private:
+    git_remote_head c_struct_;
+  };
+
   // Get the remote's list of push refspecs
   // The memory is owned by the user and should be freed
   strarray push_refspec() const;

src/remote.cpp

@@ -39,7 +39,8 @@ remote remote::create_detached_remote(const std::string &url) {
   return result;
 }
 
-remote remote::create_remote(const std::string &url, const create_options &options) {
+remote remote::create_remote(const std::string &url,
+                             const create_options &options) {
   remote result;
   if (git_remote_create_with_opts(&result.c_ptr_, url.c_str(), options.c_ptr()))
     throw git_exception();