| 1 |
commit: 0971f2e89390058a1b35a6288a2f2c396a2ad038 |
| 2 |
Author: Wolfgang E. Sanyer <WolfgangESanyer <AT> gmail <DOT> com> |
| 3 |
AuthorDate: Mon Sep 20 02:36:19 2021 +0000 |
| 4 |
Commit: Zac Medico <zmedico <AT> gentoo <DOT> org> |
| 5 |
CommitDate: Mon Sep 20 03:57:25 2021 +0000 |
| 6 |
URL: https://gitweb.gentoo.org/proj/portage.git/commit/?id=0971f2e8 |
| 7 |
|
| 8 |
Change README to markdown. Also add badge and info for black formatting. |
| 9 |
|
| 10 |
Signed-off-by: Wolfgang E. Sanyer <WolfgangESanyer <AT> gmail.com> |
| 11 |
Signed-off-by: Zac Medico <zmedico <AT> gentoo.org> |
| 12 |
|
| 13 |
README => README.md | 42 ++++++++++++++++++++++++++++++++++-------- |
| 14 |
man/make.conf.5 | 2 +- |
| 15 |
setup.py | 4 ++-- |
| 16 |
3 files changed, 37 insertions(+), 11 deletions(-) |
| 17 |
|
| 18 |
diff --git a/README b/README.md |
| 19 |
similarity index 59% |
| 20 |
rename from README |
| 21 |
rename to README.md |
| 22 |
index d2bc9fdda..c176e8a3f 100644 |
| 23 |
--- a/README |
| 24 |
+++ b/README.md |
| 25 |
@@ -1,3 +1,5 @@ |
| 26 |
+[](https://github.com/gentoo/portage/actions/workflows/ci.yml) |
| 27 |
+ |
| 28 |
About Portage |
| 29 |
============= |
| 30 |
|
| 31 |
@@ -6,6 +8,27 @@ Package Manager Specification Project (PMS) standardises and documents |
| 32 |
the behaviour of Portage so that ebuild repositories can be used by |
| 33 |
other package managers. |
| 34 |
|
| 35 |
+Contributing |
| 36 |
+============ |
| 37 |
+ |
| 38 |
+Contributions are always welcome! We've started using |
| 39 |
+[black](https://pypi.org/project/black/) to format the code base. Please make |
| 40 |
+sure you run it against any PR's prior to submitting (otherwise we'll probably |
| 41 |
+reject it). |
| 42 |
+ |
| 43 |
+There are [ways to |
| 44 |
+integrate](https://black.readthedocs.io/en/stable/integrations/editors.html) |
| 45 |
+black into your text editor and/or IDE. |
| 46 |
+ |
| 47 |
+You can also set up a git hook to check your commits, in case you don't want |
| 48 |
+editor integration. Something like this: |
| 49 |
+ |
| 50 |
+```sh |
| 51 |
+# .git/hooks/pre-commit (don't forget to chmod +x) |
| 52 |
+ |
| 53 |
+#!/bin/bash |
| 54 |
+black --check --diff . |
| 55 |
+``` |
| 56 |
|
| 57 |
Dependencies |
| 58 |
============ |
| 59 |
@@ -25,8 +48,10 @@ The following setup.cfg settings can be used to enable building of |
| 60 |
native extensions for all invocations of the build_ext command (the |
| 61 |
build_ext command is invoked automatically by other build commands): |
| 62 |
|
| 63 |
+``` |
| 64 |
[build_ext] |
| 65 |
portage_ext_modules=true |
| 66 |
+``` |
| 67 |
|
| 68 |
Currently, the native extensions only include libc bindings which are |
| 69 |
used to validate LC_CTYPE and LC_COLLATE behavior for EAPI 6. If the |
| 70 |
@@ -54,15 +79,16 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
| 71 |
More information |
| 72 |
================ |
| 73 |
|
| 74 |
--DEVELOPING contains some code guidelines. |
| 75 |
--LICENSE contains the GNU General Public License version 2. |
| 76 |
--NEWS contains new features/major bug fixes for each version. |
| 77 |
--RELEASE NOTES contains mainly upgrade information for each version. |
| 78 |
--TEST-NOTES contains Portage unit test information. |
| 79 |
+- DEVELOPING contains some code guidelines. |
| 80 |
+- LICENSE contains the GNU General Public License version 2. |
| 81 |
+- NEWS contains new features/major bug fixes for each version. |
| 82 |
+- RELEASE NOTES contains mainly upgrade information for each version. |
| 83 |
+- TEST-NOTES contains Portage unit test information. |
| 84 |
|
| 85 |
|
| 86 |
Links |
| 87 |
===== |
| 88 |
-Gentoo project page: <https://wiki.gentoo.org/wiki/Project:Portage> |
| 89 |
-PMS: <https://dev.gentoo.org/~ulm/pms/head/pms.html> |
| 90 |
-PMS git repo: <https://gitweb.gentoo.org/proj/pms.git/> |
| 91 |
+ |
| 92 |
+- Gentoo project page: https://wiki.gentoo.org/wiki/Project:Portage |
| 93 |
+- PMS: https://dev.gentoo.org/~ulm/pms/head/pms.html |
| 94 |
+- PMS git repo: https://gitweb.gentoo.org/proj/pms.git/ |
| 95 |
|
| 96 |
diff --git a/man/make.conf.5 b/man/make.conf.5 |
| 97 |
index 0790933f7..43e70803f 100644 |
| 98 |
--- a/man/make.conf.5 |
| 99 |
+++ b/man/make.conf.5 |
| 100 |
@@ -815,7 +815,7 @@ INSTALL_MASK="/usr/share/doc/*/*.pdf" |
| 101 |
|
| 102 |
# Watch out! This will be interpreted as two patterns, and |
| 103 |
# prevent both "README" AND all PDF files from being installed. |
| 104 |
-INSTALL_MASK="README\\ *.pdf" |
| 105 |
+INSTALL_MASK="README.md\\ *.pdf" |
| 106 |
.fi |
| 107 |
.TP |
| 108 |
.B LDFLAGS |
| 109 |
|
| 110 |
diff --git a/setup.py b/setup.py |
| 111 |
index 718c05f9d..77fa0808c 100755 |
| 112 |
--- a/setup.py |
| 113 |
+++ b/setup.py |
| 114 |
@@ -47,7 +47,7 @@ autodetect_pip = os.path.basename(os.environ.get("_", "")) == "pip" or os.path.b |
| 115 |
).startswith("pip-") |
| 116 |
venv_prefix = "" if sys.prefix == sys.base_prefix else sys.prefix |
| 117 |
create_entry_points = bool(autodetect_pip or venv_prefix) |
| 118 |
-with open(os.path.join(os.path.dirname(__file__), "README"), "rt") as f: |
| 119 |
+with open(os.path.join(os.path.dirname(__file__), "README.md"), "rt") as f: |
| 120 |
long_description = f.read() |
| 121 |
|
| 122 |
# TODO: |
| 123 |
@@ -816,7 +816,7 @@ setup( |
| 124 |
description="Portage is the package management and distribution system for Gentoo", |
| 125 |
license="GPLV2", |
| 126 |
long_description=long_description, |
| 127 |
- long_description_content_type="text/plain", |
| 128 |
+ long_description_content_type="text/markdown", |
| 129 |
package_dir={"": "lib"}, |
| 130 |
packages=list(find_packages()), |
| 131 |
# something to cheat build & install commands |
Archives
](https://github.com/gentoo/portage/actions/workflows/ci.yml){kind=link}