Skip to content

Commit

Permalink
Refer to Git instead of Subversion in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rodrigc committed May 17, 2016
1 parent 95acb5c commit 95c49d7
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 49 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
:LastChangedRevision: $LastChangedRevision$
:LastChangedBy: $LastChangedBy$

Working from Twisted's Subversion repository
Working from Twisted's code repository
============================================


Expand All @@ -13,7 +13,7 @@ Working from Twisted's Subversion repository
If you're going to be doing development on Twisted itself, or if you want
to take advantage of bleeding-edge features (or bug fixes) that are not yet
available in a numbered release, you'll probably want to check out a tree from
the Twisted Subversion repository. The Trunk is where all current development
the Twisted Git repository. The Trunk is where all current development
takes place.


Expand All @@ -31,7 +31,7 @@ Checkout



Subversion tutorials can be found elsewhere, see in particular `the Subversion homepage <http://subversion.apache.org/>`_ . The
Git tutorials can be found elsewhere, see in particular `Git and GitHub learning resources <https://help.github.com/articles/good-resources-for-learning-git-and-github/>`_ . The
relevant data you need to check out a copy of the Twisted tree is available on
the `development page <http://twistedmatrix.com/trac/wiki/TwistedDevelopment>`_ , and is as follows:

Expand All @@ -42,7 +42,7 @@ the `development page <http://twistedmatrix.com/trac/wiki/TwistedDevelopment>`_
.. code-block:: console
$ svn co svn://svn.twistedmatrix.com/svn/Twisted/trunk Twisted
$ git clone https://github.com/twisted/twisted Twisted
Expand All @@ -53,8 +53,8 @@ Alternate tree names



By using ``svn co svn://svn.twistedmatrix.com/svn/Twisted/trunk otherdir`` , you can put the workspace tree in a directory other than "Twisted" . I do this (with a name like "Twisted-Subversion" ) to
remind myself that this tree comes from Subversion and not from a released
By using ``git clone https://github.com/twisted/twisted otherdir`` , you can put the workspace tree in a directory other than "Twisted" . I do this (with a name like "Twisted-Git" ) to
remind myself that this tree comes from Git and not from a released
version (like "Twisted-1.0.5" ). This practice can cause a few problems,
because there are a few places in the Twisted tree that need to know where
the tree starts, so they can add it to ``sys.path`` without
Expand All @@ -81,21 +81,6 @@ problems.



Combinator
----------



In order to simplify the use of Subversion, we typically use `Divmod Combinator <http://twistedmatrix.com/trac/wiki/Combinator>`_ .
You may find it to be useful, too. In particular, because Twisted uses
branches for almost all feature development, if you plan to contribute to
Twisted you will probably find Combinator very useful. For more details,
see the Combinator website, as well as the `UQDS <http://twistedmatrix.com/trac/wiki/UltimateQualityDevelopmentSystem>`_ page.





Compiling C extensions
----------------------

Expand All @@ -114,7 +99,7 @@ The first is to do a regular distutils ``./setup.py build`` , which
will create a directory under ``build/`` to hold both the generated ``.so`` files as well as a copy of the 600-odd ``.py`` files
that make up Twisted. If you do this, you will need to set your PYTHONPATH to
something like ``MyDir/Twisted/build/lib.linux-i686-2.5`` in order to
run code against the Subversion twisted (as opposed to whatever's installed in ``/usr/lib/python2.5`` or wherever python usually looks). In
run code against the Git twisted (as opposed to whatever's installed in ``/usr/lib/python2.5`` or wherever python usually looks). In
addition, you will need to re-run the ``build`` command *every time* you change a ``.py`` file. The ``build/lib.foo``
directory is a copy of the main tree, and that copy is only updated when you
re-run ``setup.py build`` . It is easy to forget this and then wonder
Expand Down Expand Up @@ -232,9 +217,9 @@ Committing and Post-commit Hooks
--------------------------------



Twisted uses a customized `trac-post-commit-hook <http://bazaar.launchpad.net/~exarkun/twisted-trac-integration/trunk/annotate/head%3A/trac-hooks/trac-post-commit-hook>`_ to enable ticket updates based on svn commit
logs. When making a branch for a ticket, the branch name should end
Twisted's Trac installation is notified when the Git repository changes,
and will update the ticket depending on the Git commit logs.
When making a branch for a ticket, the branch name should end
in ``-<ticket number>`` , for
example ``my-branch-9999`` . This will add a ticket comment containing a
changeset link and branch name. To make your commit message show up as a comment
Expand Down
36 changes: 18 additions & 18 deletions docs/core/development/policy/coding-standard.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Overview
~~~~~~~~

Twisted development should always be `test-driven <http://en.wikipedia.org/wiki/Test-driven_development>`_ .
The complete test suite in the head of the SVN trunk is required to be passing on `supported platforms <http://buildbot.twistedmatrix.com/supported>`_ at all times.
The complete test suite in the head of the Git trunk is required to be passing on `supported platforms <http://buildbot.twistedmatrix.com/supported>`_ at all times.
Regressions in the test suite are addressed by reverting whatever revisions introduced them.


Expand Down Expand Up @@ -364,7 +364,7 @@ This makes the script more portable but note that it is not a foolproof method.
Always make sure that ``/usr/bin/env`` exists or use a softlink/symbolic link to point it to the correct path.
Python's distutils will rewrite the shebang line upon installation so this policy only covers the source files in version control.

#. For core scripts, add this Twisted running-from-SVN header:
#. For core scripts, add this Twisted running-from-Git header:

.. code-block:: python
Expand Down Expand Up @@ -400,7 +400,7 @@ Python's distutils will rewrite the shebang line upon installation so this polic
#. Write a manpage and add it to the ``man`` folder of a subproject's ``doc`` folder.
On Debian systems you can find a skeleton example of a manpage in ``/usr/share/doc/man-db/examples/manpage.example``.

This will ensure your program will work correctly for users of SVN, Windows releases and Debian packages.
This will ensure your program will work correctly for users of Git, Windows releases and Debian packages.


Examples
Expand Down Expand Up @@ -637,7 +637,7 @@ Therefore, it should be short (aim for < 80 characters) and descriptive -- and m
The rest of the e-mail should be separated with *hard line breaks* into short lines (< 70 characters).
This is free-format, so you can do whatever you like here.

Commit messages should be about *what*, not *how*: we can get how from SVN diff.
Commit messages should be about *what*, not *how*: we can get how from Git diff.
Explain reasons for commits, and what they affect.

Each commit should be a single logical change, which is internally consistent.
Expand All @@ -647,24 +647,24 @@ If you can't summarize your changes in one short line, this is probably a sign t
Source Control
--------------

Twisted currently uses Subversion for source control.
Twisted currently uses Git for source control.
All development must occur using branches; when a task is considered complete another Twisted developer may review it and if no problems are found, it may be merged into trunk.
The Twisted wiki has `a start <http://twistedmatrix.com/trac/wiki/TwistedDevelopment>`_.
Branches can be managed using `Combinator <http://divmod.org/trac/wiki/DivmodCombinator>`_ for interfacing with the SVN repo, or using `twisted-dev-tools <https://github.com/twisted/twisted-dev-tools>`_ if interacting with the Git mirror.

Certain features of Subversion should be avoided.

- Do not set the ``svn:ignore`` property on any file or directory.
What you wish to ignore, others may wish to examine.
What others may wish you ignore, *you* may wish you examine.
``svn:ignore`` will affect everyone who uses the repository, and so it is not the right mechanism to express personal preferences.

If you wish to ignore certain files use the ``global-ignores`` feature of ``~/.subversion/config``, for example:

.. code-block:: console
If you wish to ignore certain files, create a ``.gitignore`` file.
For example:

[miscellany]
global-ignores = dropin.cache *.pyc *.pyo *.o *.lo *.la #*# .*.rej *.rej .*~
.. code-block:: console
dropin.cache
*.pyc
*.pyo
*.o
*.lo
*.la #*#
.*.rej
*.rej
.*~
Fallback
Expand Down
4 changes: 2 additions & 2 deletions docs/core/development/policy/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Twisted Development Policy
writing-standard
test-standard
compatibility-policy
svn-dev
code-dev
release-process

This series of documents is designed for people who wish to contribute to the Twisted codebase.
Expand All @@ -22,5 +22,5 @@ This series of documents is designed for people who wish to contribute to the Tw
- :doc:`Documentation writing standard <writing-standard>`
- :doc:`Testing standard <test-standard>`
- :doc:`Compatibility Policy <compatibility-policy>`
- :doc:`Working from Twisted's Subversion repository <svn-dev>`
- :doc:`Working from Twisted's Git repository <code-dev>`
- :doc:`Releasing Twisted <release-process>`
6 changes: 3 additions & 3 deletions docs/core/development/policy/test-standard.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,8 @@ failing tests, they will not be happy and may decide to *hunt you down* .
Since this is a geographically dispersed team, the person who can help
you get your code working probably isn't in the room with you. You may want
to share your work in progress over the network, but you want to leave the
main Subversion tree in good working order.
So `use a branch <http://svnbook.red-bean.com/en/1.0/ch04.html>`_ ,
main Git tree in good working order.
So `use a branch <https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging>`_ ,
and merge your changes back in only after your problem is solved and all the
unit tests pass again.

Expand Down Expand Up @@ -589,7 +589,7 @@ Links
- Ron Jeffries expounds on the importance of `Unit Tests at 100% <http://www.xprogramming.com/xpmag/expUnitTestsAt100.htm>`_ .
- Ron Jeffries writes about the `Unit Test <http://www.xprogramming.com/Practices/PracUnitTest.html>`_ in the `Extreme Programming practices of C3 <http://www.xprogramming.com/Practices/xpractices.htm>`_ .
- `PyUnit's homepage <http://pyunit.sourceforge.net>`_ .
- The top-level tests directory, `twisted/test <http://twistedmatrix.com/trac/browser/trunk/twisted/test>`_ , in Subversion.
- The top-level tests directory, `twisted/test <http://twistedmatrix.com/trac/browser/trunk/twisted/test>`_ , in Git.



Expand Down
2 changes: 1 addition & 1 deletion docs/core/howto/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ the normal test-failure paths are followed. This timeout puts an upper bound
on the time that a test can consume, and prevents the entire test suite from
stalling because of a single test. This is especially important for the
Twisted test suite, because it is run automatically by the buildbot whenever
changes are committed to the Subversion repository.
changes are committed to the Git repository.



Expand Down

0 comments on commit 95c49d7

Please sign in to comment.