sonic-pi

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

C++

Code. Music. Live.

Rugged::Submodule#ignore_rule

Returns the ignore rule for a submodule.

There are four ignore values:

:none (default)::
  will consider any change to the contents of the submodule from
  a clean checkout to be dirty, including the addition of untracked files.
:untracked ::
  examines the contents of the working tree but untracked files will not
  count as making the submodule dirty.
:dirty ::
  means to only check if the +HEAD+ of the submodule has moved for status.
  This is fast since it does not need to scan the working tree
  of the submodule at all.
:all ::
  means not to open the submodule repository. The working directory will be
  considered clean so long as there is a checked out version present.

See #status on how ignore rules reflect the returned status info
for a submodule.

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_submodule.c

Contribute

# Make a new branch

git checkout -b -your-name--update-docs-Rugged--Submodule-ignore_rule-for-pr

# Commit to git

git add app/server/ruby/vendor/rugged-1.7.1/ext/rugged/rugged_submodule.cgit commit -m "better docs for Rugged::Submodule#ignore_rule"

# 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--Submodule-ignore_rule-for-pr

hub pull-request

# Celebrate!