From 6bb3e26fe25ad2a59496ad19ec34fe016a2990f0 Mon Sep 17 00:00:00 2001 From: Jeffery To Date: Thu, 11 Jun 2020 16:49:56 +0800 Subject: [PATCH] python: Revise pypi.mk section of readme Signed-off-by: Jeffery To --- lang/python/README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/lang/python/README.md b/lang/python/README.md index d0da718e9..4bceb978d 100644 --- a/lang/python/README.md +++ b/lang/python/README.md @@ -139,18 +139,18 @@ This will make sure that build rules for Python can be specified and picked up f ### Include pypi.mk (optional) -If the package source code will be downloaded from [pypi.org](https://pypi.org/), including `pypi.mk` can help simplify the package Makefile. +`pypi.mk` is an include file that makes downloading package source code from [pypi.org](https://pypi.org/) simpler. To use `pypi.mk`, add this **before** `include $(INCLUDE_DIR)/package.mk`: ``` include ../pypi.mk ``` -`pypi.mk` has several `PYPI_*` variables that must/can be set (see below); these should be set before `pypi.mk` is included, i.e. before the `include ../pypi.mk` line. +`pypi.mk` has several `PYPI_*` variables that can/must be set (see below); these should be set before `pypi.mk` is included, i.e. before the `include ../pypi.mk` line. `pypi.mk` also provides default values for `PKG_SOURCE` and `PKG_SOURCE_URL`, so these variables may be omitted. -One variable is required: +Required variables: * `PYPI_NAME`: Package name on pypi.org. This should match the PyPI name exactly. @@ -159,7 +159,7 @@ One variable is required: PYPI_NAME:=PyYAML ``` -These variables are optional: +Optional variables: * `PYPI_SOURCE_NAME`: Package name component of the source tarball filename Default: Same value as `PYPI_NAME` @@ -172,8 +172,6 @@ These variables are optional: PKG_SOURCE?=$(PYPI_SOURCE_NAME)-$(PKG_VERSION).$(PYPI_SOURCE_EXT) ``` -The `PYPI_SOURCE_*` variables allow this default `PKG_SOURCE` value to be customized as necessary. - ### Add Package/ OpenWrt definitions This part is similar to default OpenWrt packages.