Menu
▾
▴
[Docutils-checkins] SF.net SVN: docutils:[8852] trunk/docutils
|
From: <mi...@us...> - 2021-10-12 22:16:46
|
Revision: 8852
http://sourceforge.net/p/docutils/code/8852
Author: milde
Date: 2021-10-12 22:16:43 +0000 (Tue, 12 Oct 2021)
Log Message:
-----------
Small documentation update.
Modified Paths:
--------------
trunk/docutils/FAQ.txt
trunk/docutils/docs/dev/policies.txt
trunk/docutils/docs/dev/repository.txt
Modified: trunk/docutils/FAQ.txt
===================================================================
--- trunk/docutils/FAQ.txt 2021-10-12 17:33:24 UTC (rev 8851)
+++ trunk/docutils/FAQ.txt 2021-10-12 22:16:43 UTC (rev 8852)
@@ -108,11 +108,8 @@
Is there a GUI authoring environment for Docutils?
--------------------------------------------------
-DocFactory_ is under development. See also the links to editors_
-supporting reStructuredText.
+See the links to editors_ supporting reStructuredText.
-.. _DocFactory:
- http://docutils.sf.net/sandbox/gschwant/docfactory/doc/
.. _editors: docs/user/links.html#editors
@@ -122,9 +119,9 @@
Docutils is mainly stable, with documented APIs and architecture
subject to change after announcement and a transition period.
-We fix bugs as they are reported. So the latest code from the
-repository_ (or the snapshots_) are almost always the most stable
-as well as the most featureful.
+We fix bugs as they are reported. This means the code from the
+repository_ (or the snapshots_) is the most stable as well as the most
+featureful most of the time.
What is the Docutils project release policy?
@@ -141,6 +138,19 @@
.. _repository: docs/dev/repository.html
+How can I get a new feature into Docutils?
+------------------------------------------
+
+Present your idea at the docutils-develop_ mailing list
+or file a ticket at Docutils' `feature request tracker`_.
+
+See the `Docutils Policies`__ for a more detailled answer.
+
+.. _docutils-develop: docs/user/mailing-lists.html#docutils-develop
+.. _feature request tracker:
+ http://sourceforge.net/p/docutils/feature-requests/
+__ docs/dev/policies.html#how-to-get-a-new-feature-into-docutils
+
reStructuredText
================
Modified: trunk/docutils/docs/dev/policies.txt
===================================================================
--- trunk/docutils/docs/dev/policies.txt 2021-10-12 17:33:24 UTC (rev 8851)
+++ trunk/docutils/docs/dev/policies.txt 2021-10-12 22:16:43 UTC (rev 8852)
@@ -77,7 +77,8 @@
* Be patient, and be persistent. None of us are paid to do this,
it's all in our spare time -- which is precious and rare.
-How to make code contributions that are easily accepted:
+How to make code contributions that are easily accepted
+-------------------------------------------------------
* Have a look at the `Python coding conventions`_ and `documentation
conventions`_ below.
@@ -98,13 +99,17 @@
* If you are familiar with version control, consider creating a `feature
branch`_ in a Docutils repository_ checkout. (Working with branches is
- *much* easier with git_. You can get a git clone of the repository from
+ *much* easier with Git_. You can get a Git clone of the repository from
http://repo.or.cz/w/docutils.git or with git-svn.)
+
+* Mail your patch to the Docutils-develop_ mailing list or attach it to the
+ relevant ticket at Docutils' `feature request tracker`_.
+ We accept patches created with diff, SVN, or Git.
+
.. _docutils-develop: ../user/mailing-lists.html#docutils-develop
.. _feature request tracker:
- http://sourceforge.net/p/docutils/feature-requests/
-
+ http://sourceforge.net/p/docutils/feature-requests/
.. _git: http://git-scm.com/
.. _Docutils testing: testing.html
Modified: trunk/docutils/docs/dev/repository.txt
===================================================================
--- trunk/docutils/docs/dev/repository.txt 2021-10-12 17:33:24 UTC (rev 8851)
+++ trunk/docutils/docs/dev/repository.txt 2021-10-12 22:16:43 UTC (rev 8852)
@@ -1,5 +1,5 @@
=====================================
- The Docutils_ Subversion Repository
+ The Docutils_ Version Repository
=====================================
:Author: Lea Wiemann
@@ -34,13 +34,10 @@
TortoiseSVN_, a convenient explorer extension. The instructions apply
analogously.
-There is a git_ mirror at http://repo.or.cz/docutils.git providing
-`web access`_ and the base for `creating a local git clone`_.
+There is a Git_ mirror at http://repo.or.cz/docutils.git (and one at
+`github <https://github.com/live-clones/docutils/tree/master/docutils>`_).
+Both provide `web access`_ and the base for `creating a local Git clone`_.
-and docutils trunk is cloned hourly to github :
-
- https://github.com/live-clones/docutils/tree/master/docutils
-
For the project policy on repository use (check-in requirements,
branching, etc.), please see the `Docutils Project Policies`__.
@@ -50,7 +47,7 @@
.. _Subversion Book: http://svnbook.red-bean.com/
.. _TortoiseSVN: http://tortoisesvn.tigris.org/
.. _SourceForge.net: http://sourceforge.net/
-.. _git: http://git-scm.com/
+.. _Git: http://git-scm.com/
.. contents::
@@ -67,24 +64,35 @@
The repository can be browsed and examined via the web at
http://sourceforge.net/p/docutils/code
-Alternatively, use the web interface of the git mirror at
-http://repo.or.cz/w/docutils.git.
+Alternatively, use the web interface of the Git mirrors at
+http://repo.or.cz/docutils.git or github_.
Repository Access Methods
~~~~~~~~~~~~~~~~~~~~~~~~~
-To get a checkout of the Docutils repository, first determine the root
-of the repository depending on your preferred protocol:
+Users of Git_ can clone a mirror of the docutils repository with ::
+ git clone git://repo.or.cz/docutils.git
+
+and proceed according to the `Git documentation`_.
+Developer access (read and write) is possible with `git svn`_.
+
+.. _Git documentation: https://git.wiki.kernel.org/index.php/GitDocumentation
+.. _git svn: https://git.wiki.kernel.org/index.php/Git-svn
+
+
+To get a checkout with Subversion_, first determine
+the root of the repository depending on your preferred protocol:
+
anonymous access: (read only)
``http://svn.code.sf.net/p/docutils/code``
+
+ .. _creating a local Git clone:
`developer access`_: (read and write)
``svn+ssh://<USERNAME>@svn.code.sf.net/p/docutils/code``
-.. git clone: (read only)
- ``git clone git://repo.or.cz/docutils.git``
Checking Out the Repository
~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -119,18 +127,7 @@
svn switch --relocate OLDROOT NEWROOT
-Creating a local git clone
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-Users of git_ can clone a mirror of the docutils repository with ::
-
- git clone git://repo.or.cz/docutils.git
-
-and proceed according to the `git documentation`_.
-
-.. _git documentation: http://git-scm.com/documentation
-
-
.. _developer access:
Information for Developers
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
