openstack/deb-python-pygit2
Code Issues Proposed changes
Files
5c0dee16b8641e3f67a7183513ca5baeb46c33f5
deb-python-pygit2/docs/references.rst
J. David Ibáñez 32e460fe16 docs: complete and improve organization
2013-04-03 19:09:48 +02:00

1.8 KiB
Raw Blame History

References

pygit2.Repository.listall_references

pygit2.Repository.lookup_reference

Reference lookup:

>>> all_refs = repo.listall_references()
>>> master_ref = repo.lookup_reference("refs/heads/master")
>>> commit = repo[master_ref.oid]

Reference log:

>>> head = repo.lookup_reference('refs/heads/master')
>>> for entry in head.log():
...     print(entry.message)

The interface for RefLogEntry:

RefLogEntry.committer -- Signature of Committer
RefLogEntry.message   -- the message of the RefLogEntry
RefLogEntry.oid_old   -- oid of old reference
RefLogEntry.oid_new   -- oid of new reference

The Reference type

pygit2.Reference.name

pygit2.Reference.oid

pygit2.Reference.hex

pygit2.Reference.target

pygit2.Reference.type

pygit2.Reference.delete

pygit2.Reference.rename

pygit2.Reference.resolve

pygit2.Reference.log

The reference log

pygit2.RefLogEntry.oid_new

pygit2.RefLogEntry.oid_old

pygit2.RefLogEntry.message

pygit2.RefLogEntry.committer

Notes

pygit2.Repository.notes

pygit2.Repository.create_note

pygit2.Repository.lookup_note

The Note type

pygit2.Note.annotated_id

pygit2.Note.oid

pygit2.Note.message

pygit2.Note.remove