public inbox for gentoo-commits@lists.gentoo.org
 help / color / mirror / Atom feed
* [gentoo-commits] proj/portage:master commit in: /, man/
@ 2021-09-20  3:58 Zac Medico
  0 siblings, 0 replies; 2+ messages in thread
From: Zac Medico @ 2021-09-20  3:58 UTC (permalink / raw
  To: gentoo-commits

commit:     0971f2e89390058a1b35a6288a2f2c396a2ad038
Author:     Wolfgang E. Sanyer <WolfgangESanyer <AT> gmail <DOT> com>
AuthorDate: Mon Sep 20 02:36:19 2021 +0000
Commit:     Zac Medico <zmedico <AT> gentoo <DOT> org>
CommitDate: Mon Sep 20 03:57:25 2021 +0000
URL:        https://gitweb.gentoo.org/proj/portage.git/commit/?id=0971f2e8

Change README to markdown. Also add badge and info for black formatting.

Signed-off-by: Wolfgang E. Sanyer <WolfgangESanyer <AT> gmail.com>
Signed-off-by: Zac Medico <zmedico <AT> gentoo.org>

 README => README.md | 42 ++++++++++++++++++++++++++++++++++--------
 man/make.conf.5     |  2 +-
 setup.py            |  4 ++--
 3 files changed, 37 insertions(+), 11 deletions(-)

diff --git a/README b/README.md
similarity index 59%
rename from README
rename to README.md
index d2bc9fdda..c176e8a3f 100644
--- a/README
+++ b/README.md
@@ -1,3 +1,5 @@
+[![CI](https://github.com/gentoo/portage/actions/workflows/ci.yml/badge.svg)](https://github.com/gentoo/portage/actions/workflows/ci.yml)
+
 About Portage
 =============
 
@@ -6,6 +8,27 @@ Package Manager Specification Project (PMS) standardises and documents
 the behaviour of Portage so that ebuild repositories can be used by
 other package managers.
 
+Contributing
+============
+
+Contributions are always welcome! We've started using
+[black](https://pypi.org/project/black/) to format the code base. Please make
+sure you run it against any PR's prior to submitting (otherwise we'll probably
+reject it).
+
+There are [ways to
+integrate](https://black.readthedocs.io/en/stable/integrations/editors.html)
+black into your text editor and/or IDE.
+
+You can also set up a git hook to check your commits, in case you don't want
+editor integration. Something like this:
+
+```sh
+# .git/hooks/pre-commit (don't forget to chmod +x)
+
+#!/bin/bash
+black --check --diff .
+```
 
 Dependencies
 ============
@@ -25,8 +48,10 @@ The following setup.cfg settings can be used to enable building of
 native extensions for all invocations of the build_ext command (the
 build_ext command is invoked automatically by other build commands):
 
+```
    [build_ext]
    portage_ext_modules=true
+```
 
 Currently, the native extensions only include libc bindings which are
 used to validate LC_CTYPE and LC_COLLATE behavior for EAPI 6. If the
@@ -54,15 +79,16 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 More information
 ================
 
--DEVELOPING contains some code guidelines.
--LICENSE contains the GNU General Public License version 2.
--NEWS contains new features/major bug fixes for each version.
--RELEASE NOTES contains mainly upgrade information for each version.
--TEST-NOTES contains Portage unit test information.
+- DEVELOPING contains some code guidelines.
+- LICENSE contains the GNU General Public License version 2.
+- NEWS contains new features/major bug fixes for each version.
+- RELEASE NOTES contains mainly upgrade information for each version.
+- TEST-NOTES contains Portage unit test information.
 
 
 Links
 =====
-Gentoo project page: <https://wiki.gentoo.org/wiki/Project:Portage>
-PMS: <https://dev.gentoo.org/~ulm/pms/head/pms.html>
-PMS git repo: <https://gitweb.gentoo.org/proj/pms.git/>
+
+- Gentoo project page: https://wiki.gentoo.org/wiki/Project:Portage
+- PMS: https://dev.gentoo.org/~ulm/pms/head/pms.html
+- PMS git repo: https://gitweb.gentoo.org/proj/pms.git/

diff --git a/man/make.conf.5 b/man/make.conf.5
index 0790933f7..43e70803f 100644
--- a/man/make.conf.5
+++ b/man/make.conf.5
@@ -815,7 +815,7 @@ INSTALL_MASK="/usr/share/doc/*/*.pdf"
 
 # Watch out! This will be interpreted as two patterns, and
 # prevent both "README" AND all PDF files from being installed.
-INSTALL_MASK="README\\ *.pdf"
+INSTALL_MASK="README.md\\ *.pdf"
 .fi
 .TP
 .B LDFLAGS

diff --git a/setup.py b/setup.py
index 718c05f9d..77fa0808c 100755
--- a/setup.py
+++ b/setup.py
@@ -47,7 +47,7 @@ autodetect_pip = os.path.basename(os.environ.get("_", "")) == "pip" or os.path.b
 ).startswith("pip-")
 venv_prefix = "" if sys.prefix == sys.base_prefix else sys.prefix
 create_entry_points = bool(autodetect_pip or venv_prefix)
-with open(os.path.join(os.path.dirname(__file__), "README"), "rt") as f:
+with open(os.path.join(os.path.dirname(__file__), "README.md"), "rt") as f:
     long_description = f.read()
 
 # TODO:
@@ -816,7 +816,7 @@ setup(
     description="Portage is the package management and distribution system for Gentoo",
     license="GPLV2",
     long_description=long_description,
-    long_description_content_type="text/plain",
+    long_description_content_type="text/markdown",
     package_dir={"": "lib"},
     packages=list(find_packages()),
     # something to cheat build & install commands


^ permalink raw reply related	[flat|nested] 2+ messages in thread

* [gentoo-commits] proj/portage:master commit in: /, man/
@ 2023-08-19 14:59 Sam James
  0 siblings, 0 replies; 2+ messages in thread
From: Sam James @ 2023-08-19 14:59 UTC (permalink / raw
  To: gentoo-commits

commit:     45341379cdcdfb74ab44ffb0297564f12fb9beb5
Author:     Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sat Aug 19 14:58:24 2023 +0000
Commit:     Sam James <sam <AT> gentoo <DOT> org>
CommitDate: Sat Aug 19 14:59:00 2023 +0000
URL:        https://gitweb.gentoo.org/proj/portage.git/commit/?id=45341379

make.conf.5: mention https_proxy

We support it as of recent (from today) commits.

Bug: https://bugs.gentoo.org/587484
Signed-off-by: Sam James <sam <AT> gentoo.org>

 NEWS            | 2 ++
 man/make.conf.5 | 2 +-
 2 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/NEWS b/NEWS
index 1f789c6f27..25417c99ef 100644
--- a/NEWS
+++ b/NEWS
@@ -17,6 +17,8 @@ Bug fixes:
 * misc/emerge-delta-webrsync: Fix PGP logic which prevented syncing for this
   rarely-used tool (bug #911335).
 
+* make.conf(5): Mention https_proxy.
+
 portage-3.0.50 (2023-08-09)
 --------------
 

diff --git a/man/make.conf.5 b/man/make.conf.5
index 75206d5e75..a1a433b108 100644
--- a/man/make.conf.5
+++ b/man/make.conf.5
@@ -871,7 +871,7 @@ The user name used to drop root privileges during verification.
 Defaults to "nobody"
 .br
 .TP
-\fBhttp_proxy ftp_proxy RSYNC_PROXY\fR = \fI[protocol://host:port]\fR
+\fBhttp_proxy https_proxy ftp_proxy RSYNC_PROXY\fR = \fI[protocol://host:port]\fR
 These variables are used by network clients such as \fBwget\fR(1) and
 \fBrsync\fR(1). They are only required if you use a
 proxy server for internet access.


^ permalink raw reply related	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2023-08-19 14:59 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-08-19 14:59 [gentoo-commits] proj/portage:master commit in: /, man/ Sam James
  -- strict thread matches above, loose matches on Subject: below --
2021-09-20  3:58 Zac Medico

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox