31fc235b59
Use the right namespace so Refspec and TransferProgress show up. These classes are not instantiated by the user, so they were not promoted to the pygit2 module. Use autoclass so it lists everything for us. Also use autoclass for the reflog. We had a difference is oid vs id between the docs and the code.
130 lines
3.7 KiB
ReStructuredText
130 lines
3.7 KiB
ReStructuredText
**********************************************************************
|
|
References
|
|
**********************************************************************
|
|
|
|
.. contents::
|
|
|
|
.. automethod:: pygit2.Repository.listall_references
|
|
.. automethod:: pygit2.Repository.lookup_reference
|
|
|
|
Example::
|
|
|
|
>>> all_refs = repo.listall_references()
|
|
>>> master_ref = repo.lookup_reference("refs/heads/master")
|
|
>>> commit = master_ref.get_object() # or repo[master_ref.target]
|
|
|
|
|
|
The Reference type
|
|
====================
|
|
|
|
.. autoattribute:: pygit2.Reference.name
|
|
.. autoattribute:: pygit2.Reference.shorthand
|
|
.. autoattribute:: pygit2.Reference.target
|
|
.. autoattribute:: pygit2.Reference.type
|
|
|
|
.. automethod:: pygit2.Reference.delete
|
|
.. automethod:: pygit2.Reference.rename
|
|
.. automethod:: pygit2.Reference.resolve
|
|
.. automethod:: pygit2.Reference.log
|
|
.. automethod:: pygit2.Reference.log_append
|
|
|
|
Example::
|
|
|
|
>>> branch = repository.lookup_reference("refs/heads/master")
|
|
>>> branch.target = another_commit.id
|
|
>>> committer = Signature('Cecil Committer', 'cecil@committers.tld')
|
|
>>> branch.log_append(another_commit.id, committer,
|
|
"changed branch target using pygit2")
|
|
|
|
This creates a reflog entry in ``git reflog master`` which looks like::
|
|
|
|
7296b92 master@{10}: changed branch target using pygit2
|
|
|
|
In order to make an entry in ``git reflog``, ie. the reflog for ``HEAD``, you
|
|
have to get the Reference object for ``HEAD`` and call ``log_append`` on
|
|
that.
|
|
|
|
.. automethod:: pygit2.Reference.get_object
|
|
|
|
|
|
The HEAD
|
|
====================
|
|
|
|
Example. These two lines are equivalent::
|
|
|
|
>>> head = repo.lookup_reference('HEAD').resolve()
|
|
>>> head = repo.head
|
|
|
|
.. autoattribute:: pygit2.Repository.head
|
|
.. autoattribute:: pygit2.Repository.head_is_detached
|
|
.. autoattribute:: pygit2.Repository.head_is_unborn
|
|
|
|
Branches
|
|
====================
|
|
|
|
Branches inherit from References, and additionally provide specialized
|
|
accessors for some unique features.
|
|
|
|
.. automethod:: pygit2.Repository.listall_branches
|
|
.. automethod:: pygit2.Repository.lookup_branch
|
|
.. automethod:: pygit2.Repository.create_branch
|
|
|
|
Example::
|
|
|
|
>>> local_branches = repo.listall_branches()
|
|
>>> # equivalent to
|
|
>>> local_branches = repo.listall_branches(pygit2.GIT_BRANCH_LOCAL)
|
|
|
|
>>> remote_branches = repo.listall_branches(pygit2.GIT_BRANCH_REMOTE)
|
|
|
|
>>> all_branches = repo.listall_branches(pygit2.GIT_BRANCH_REMOTE |
|
|
pygit2.GIT_BRANCH_LOCAL)
|
|
|
|
>>> master_branch = repo.lookup_branch('master')
|
|
>>> # equivalent to
|
|
>>> master_branch = repo.lookup_branch('master',
|
|
pygit2.GIT_BRANCH_LOCAL)
|
|
|
|
>>> remote_branch = repo.lookup_branch('upstream/feature',
|
|
pygit2.GIT_BRANCH_REMOTE)
|
|
|
|
The Branch type
|
|
====================
|
|
|
|
.. autoattribute:: pygit2.Branch.branch_name
|
|
.. autoattribute:: pygit2.Branch.remote_name
|
|
.. autoattribute:: pygit2.Branch.upstream
|
|
.. autoattribute:: pygit2.Branch.upstream_name
|
|
|
|
.. automethod:: pygit2.Branch.rename
|
|
.. automethod:: pygit2.Branch.delete
|
|
.. automethod:: pygit2.Branch.is_head
|
|
|
|
The reference log
|
|
====================
|
|
|
|
Example::
|
|
|
|
>>> head = repo.lookup_reference('refs/heads/master')
|
|
>>> for entry in head.log():
|
|
... print(entry.message)
|
|
|
|
.. autoclass:: pygit2.RefLogEntry
|
|
:members:
|
|
|
|
Notes
|
|
====================
|
|
|
|
.. automethod:: pygit2.Repository.notes
|
|
.. automethod:: pygit2.Repository.create_note
|
|
.. automethod:: pygit2.Repository.lookup_note
|
|
|
|
|
|
The Note type
|
|
--------------------
|
|
|
|
.. autoattribute:: pygit2.Note.annotated_id
|
|
.. autoattribute:: pygit2.Note.id
|
|
.. autoattribute:: pygit2.Note.message
|
|
.. automethod:: pygit2.Note.remove
|