sonic-pi

https://github.com/sonic-pi-net/sonic-pi

C++

Code. Music. Live.

Rugged::Remote#ls

Connects +remote+ to list all references available along with their
associated commit ids.

The given block is called once for each remote head with a Hash containing the
following keys:

:local? ::
  +true+ if the remote head is available locally, +false+ otherwise.

:oid ::
  The id of the object the remote head is currently pointing to.

:loid ::
  The id of the object the local copy of the remote head is currently
  pointing to. Set to +nil+ if there is no local copy of the remote head.

:name ::
  The fully qualified reference name of the remote head.

If no block is given, an enumerator will be returned.

The following options can be passed in the +options+ Hash:

:credentials ::
  The credentials to use for the ls operation. Can be either an instance of one
  of the Rugged::Credentials types, or a proc returning one of the former.
  The proc will be called with the +url+, the +username+ from the url (if applicable) and
  a list of applicable credential types.

:headers ::
  Extra HTTP headers to include with the request (only applies to http:// or https:// remotes)

Source | Google | Stack overflow

Edit

git clone [email protected]:sonic-pi-net/sonic-pi.git

cd sonic-pi

open app/server/ruby/vendor/rugged-1.7.1/ext/rugged/rugged_remote.c

Contribute

# Make a new branch

git checkout -b -your-name--update-docs-Rugged--Remote-ls-for-pr

# Commit to git

git add app/server/ruby/vendor/rugged-1.7.1/ext/rugged/rugged_remote.cgit commit -m "better docs for Rugged::Remote#ls"

# Open pull request

gem install hub # on a mac you can `brew install hub`

hub fork

git push <your name> -your-name--update-docs-Rugged--Remote-ls-for-pr

hub pull-request

# Celebrate!