#189 Remove 'prest'

[Adam Turner]

xref sourceforge.net/p/docutils/mailman/message/36748625 -- an earlier attempt.

It has now been 11 years (08/12/2010), and no changes. The code will remain in the souce control history should anyone want to revive it.

The first commit removes all the files under /prest and the second removes a final reference in the docs.

This code was quite confusing to me when I was first looking throuh the Docutils source tree - I hestitated to contribute for a while as I thought I might need to know Perl or need to translate any contributions.

As a current contributor, when searching through the full codebase, there are spurious results from prest that are annoying -- not insurmountable, but a common annoyance, and I think dropping this would solve both issues of clarity (Docutils is purely a Python project) and developer experience.

A

https://github.com/AA-Turner/docutils/pull/5 // https://github.com/AA-Turner/docutils/pull/5.patch

[Adam Turner]

If it does not complicate this future separation, we may put "prest" to a rest now (maybe leaving prest/README).

I don't think it would, you'd just have one less repository.

The plan here is, to split "prest" into a separate repository when moving to Git.

Ahh perfect, I didn't realise moving to Git had been agreed! Very happy to help out if you'd like.

If you wanted to keep 'prest' as you say it could just be split out into a different repository.

A

[Günter Milde]

I didn't realise moving to Git had been agreed!

There is agreement that using Git for version control is fine --- if done right.
There is no consensus on a possible new host nor on a timeline.
My suggestion is in the To Do List.

[Adam Turner]

(I can't see @milde/Günter's response here, it may have gotten lost -- for context I was replying to him).

[Takeshi KOMIYA]

It would be great if we'll be able to install the HEAD of docutils via
git command directly.
At present, we need to clone the repository before installing it
because docutils package is placed under the docutils directory.
The separation will resolve that.

[Adam Turner]

@Takeshi KOMIYA

Pip can install from a git subdirectory (https://pip.pypa.io/en/stable/topics/vcs-support/#url-fragments) -- this should work: python -m pip install git+https://repo.or.cz/docutils.git#subdirectory=docutils

A

---

tested:

PS S:\Development\docutils-git-test> python -V
Python 3.9.7
PS S:\Development\docutils-git-test> python -m venv venv
PS S:\Development\docutils-git-test> .\venv\Scripts\Activate.ps1
(venv) PS S:\Development\docutils-git-test> python -m pip install --upgrade --quiet pip
(venv) PS S:\Development\docutils-git-test> python -m pip -V
pip 21.3.1 from S:\Development\docutils-git-test\venv\lib\site-packages\pip (python 3.9)
(venv) PS S:\Development\docutils-git-test> python -m pip install git+https://repo.or.cz/docutils.git#subdirectory=docutils
Collecting git+https://repo.or.cz/docutils.git#subdirectory=docutils
  Cloning https://repo.or.cz/docutils.git to z:\users\adam\pip-req-build-vfs5w0kd
  Running command git clone --filter=blob:none -q https://repo.or.cz/docutils.git 'Z:\Users\Adam\pip-req-build-vfs5w0kd'
  warning: filtering not recognized by server, ignoring
  Resolved https://repo.or.cz/docutils.git to commit 3e71d462b39f828cc612b64cd5bd5c804099a968
  Preparing metadata (setup.py) ... done
Using legacy 'setup.py install' for docutils, since package 'wheel' is not installed.
Installing collected packages: docutils
    Running setup.py install for docutils ... done
Successfully installed docutils-0.19b0.dev0
(venv) PS S:\Development\docutils-git-test> python -c "import docutils; print(docutils.__version__)"
0.19b.dev

[Adam Turner]

Replying to Günter Milde

There is agreement that using Git for version control is fine --- if done right.

Of course, and changing something to lead to a worse outcome is pointless.

There is no consensus on a possible new host nor on a timeline.

Would it help if somebody wrote up a discussion document (not as formal as a PEP!)?

I would be prepared to do so myself if you'd find it useful, but equally there may be other important things you'd rather do first. Let me know either way, I'm just happy to help wherever's best :)

My suggestion is in the To Do List.

I've just read through that and it makes sense -- very much agree with David's comments. You can also use a tool such as git-filter-repo ( https://github.com/newren/git-filter-repo ) for history rewriting. https://gist.github.com/tony/c5ebdc02a5c58e34956d seems to be fairly comprehensive too. (More pointing out alternatives rather than a concrete proposal -- as I said above, I'm happy to be patient if needed!)

A

[Günter Milde]

Thank you for the suggestion, the motivation.
@mnodnine: Do you have plans for "prest" or would it be OK to move it to the attic.
Earlier versions stay available in the SVN repo, e.g. the last commit [r8953].
If/When moving to Git, the project can move to a separate repository.

[Adam Turner]

It's been a fortnight with no response from Mark / others -- just checking here if you'd want to wait any further?

(I saw the status changed to "pending-remind", but I'm not sure when the "remind" part kicks in!)

A

[Günter Milde]

On 2022-01-28, Adam Turner via Docutils-develop wrote in gmane.text.docutils.devel:

It's been a fortnight with no response from Mark / others -- just
checking here if you'd want to wait any further?

I'd wait for 2 more weeks. Remember, Docutils development is slow...

[Adam Turner]

This can now be closed -- thanks Günter!
A