Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sort out clone machine edge cases #21

Open
scravy opened this issue Oct 4, 2018 · 5 comments
Open

Sort out clone machine edge cases #21

scravy opened this issue Oct 4, 2018 · 5 comments
Assignees
Labels
bug A problem of existing functionality

Comments

@scravy
Copy link
Member

scravy commented Oct 4, 2018

The clone machine does trivial transformations of the bitcoin codebase. For example it renames bitcoin into unit-e where it's safe to do so.

Occasionally it renames some things (all in documentation, READMEs and such) which it shouldn't – for instance it renames names of python packages like python-bitcoinlib to things which actually should not exist.

These should be changed back manually (it's not a terribly lot) and blacklisted in the clone machine. The clone machine already features mechanisms to black list certain items.

@scravy scravy self-assigned this Oct 4, 2018
@cornelius
Copy link
Member

We have an additional mechanism to replace files by the unit-e version now. This covers some of the mentioned edge cases such as the README (and some more files).

We do have to look at the remaining cases where things are renamed which shouldn't and cover them in the blacklists and such.

I would suggest to do that once we have the final naming in place (dtr-org/unit-e#228) and we have adapted clonemachine to do the renaming accordingly (i.e. issue https://github.com/dtr-org/unit-e/issues/296).

@cornelius
Copy link
Member

One more corner-case: In the help texts of the RPC commands there are various occurrences of "unite address". These should probably rather be "Unit-e address".

@cornelius cornelius transferred this issue from dtr-org/unit-e Dec 20, 2018
@cornelius cornelius added the bug A problem of existing functionality label Dec 20, 2018
@cornelius
Copy link
Member

cornelius commented Feb 19, 2019

Some more edge cases to fix:

@cornelius
Copy link
Member

One more edge case: doc/README_windows.txt has CRLF line endings in bitcoin. Clonemachine converts that to CR. As this file is put into the Windows installer we probably need to keep the CRLF line endings there.

@cornelius
Copy link
Member

Most of the edge cases have been resolved now. This is a summary of what is left to do:

  • References to bitcointalk.org, and the #bitcoin channel on IRC should not be touched to avoid merge conflicts.
  • References to the bitcoin git repository are not replaced anymore. This is generally correct because it usually refers to code pieces, issues, or pull requests which are actually in bitcoin. There are some cases where we need to replace them by references to the unit-e repository, e.g. in build instructions (example: doc/build-netbsd.md).
  • Substitution of the values of DOCSET_BUNDLE_ID and DOCSET_PUBLISHER_ID in doc/Doxyfile has to be corrected.
  • In doc/benchmarking there is a mention of "bitcoin-core". This should be substituted to "unit-e".
  • The CRLF line endings of doc/README_windows.txt should be preserved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug A problem of existing functionality
Projects
None yet
Development

No branches or pull requests

2 participants