blob: 3479bb2d8e6baf581e099527c0c0d14fbd17400c (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
# This file is part of ranger, the console file manager.
# License: GNU GPL version 3, see the file "AUTHORS" for details.
NAME = ranger
VERSION = $(shell grep -m 1 -o '[0-9][0-9.]\+\S*' README.md)
NAME_RIFLE = rifle
VERSION_RIFLE = $(VERSION)
SNAPSHOT_NAME ?= $(NAME)-$(VERSION)-$(shell git rev-parse HEAD | cut -b 1-8).tar.gz
# Find suitable python version (need python >= 2.6 or 3.1):
PYTHON ?= $(shell \
(which python3) \
|| (python -c 'import sys; sys.exit(sys.version < "2.6")' && \
which python) \
|| (python2 -c 'import sys; sys.exit(sys.version < "2.6")' && \
which python2) \
)
ifeq ($(PYTHON),)
$(error No suitable python found.)
endif
SETUPOPTS ?= '--record=install_log.txt'
DOCDIR ?= doc/pydoc
DESTDIR ?= /
PREFIX ?= /usr/local
PYOPTIMIZE ?= 1
FILTER ?= .
CWD = $(shell pwd)
bold := $(shell tput bold)
normal := $(shell tput sgr0)
default: test compile
@echo 'Run `make options` for a list of all options'
options: help
@echo
@echo 'Options:'
@echo 'PYTHON = $(PYTHON)'
@echo 'PYOPTIMIZE = $(PYOPTIMIZE)'
@echo 'DOCDIR = $(DOCDIR)'
@echo 'DESTDIR = $(DESTDIR)'
help:
@echo 'make: Test and compile ranger.'
@echo 'make install: Install $(NAME)'
@echo 'make pypi_sdist: Release a new sdist to PyPI'
@echo 'make clean: Remove the compiled files (*.pyc, *.pyo)'
@echo 'make doc: Create the pydoc documentation'
@echo 'make cleandoc: Remove the pydoc documentation'
@echo 'make man: Compile the manpage with "pod2man"'
@echo 'make manhtml: Compile the html manpage with "pod2html"'
@echo 'make snapshot: Create a tar.gz of the current git revision'
@echo 'make test: Test everything'
@echo 'make test_pylint: Test using pylint'
@echo 'make test_flake8: Test using flake8'
@echo 'make test_doctest: Test using doctest'
@echo 'make test_pytest: Test using pytest'
@echo 'make test_other: Verify the manpage is complete'
@echo 'make test_py: Run all python tests, including manpage completeness'
@echo 'make test_shellcheck: Test using shellcheck'
@echo 'make todo: Look for TODO and XXX markers in the source code'
install:
$(PYTHON) setup.py install $(SETUPOPTS) \
'--prefix=$(PREFIX)' '--root=$(DESTDIR)' \
--optimize=$(PYOPTIMIZE)
compile: clean
PYTHONOPTIMIZE=$(PYOPTIMIZE) $(PYTHON) -m compileall -q ranger
clean:
find ranger -regex .\*\.py[co]\$$ -delete
find ranger -depth -name __pycache__ -type d -exec rm -r -- {} \;
doc: cleandoc
mkdir -p $(DOCDIR)
cd $(DOCDIR); \
$(PYTHON) -c 'import pydoc, sys; \
sys.path[0] = "$(CWD)"; \
pydoc.writedocs("$(CWD)")'
find . -name \*.html -exec sed -i 's|'"$(CWD)"'|../..|g' -- {} \;
TEST_PATHS_MAIN = \
$(shell find ./ranger -mindepth 1 -maxdepth 1 -type d \
! -name '__pycache__' \
! -path './ranger/config' \
! -path './ranger/data' \
) \
./ranger/__init__.py \
$(shell find ./doc/tools ./examples -type f -name '*.py') \
./ranger.py \
./setup.py \
./tests
TEST_PATH_CONFIG = ./ranger/config
test_pylint:
@echo "$(bold)Running pylint...$(normal)"
pylint $(TEST_PATHS_MAIN)
pylint --rcfile=$(TEST_PATH_CONFIG)/.pylintrc $(TEST_PATH_CONFIG)
test_flake8:
@echo "$(bold)Running flake8...$(normal)"
flake8 $(TEST_PATHS_MAIN) $(TEST_PATH_CONFIG)
@echo
test_doctest:
@echo "$(bold)Running doctests...$(normal)"
@set -e; \
for FILE in $(shell grep -IHm 1 doctest -r ranger | grep $(FILTER) | cut -d: -f1); do \
echo "Testing $$FILE..."; \
RANGER_DOCTEST=1 PYTHONPATH=".:"$$PYTHONPATH ${PYTHON} $$FILE; \
done
@echo
test_pytest:
@echo "$(bold)Running py.test tests...$(normal)"
py.test tests
@echo
test_py: test_pylint test_flake8 test_doctest test_pytest test_other
@echo "$(bold)Finished python and documentation tests!$(normal)"
@echo
test_shellcheck:
@echo "$(bold)Running shellcheck...$(normal)"
sed '2,$$s/^\([[:blank:]]*\)#/\1/' ./ranger/data/scope.sh \
| shellcheck -a -
@echo
test_other:
@echo "$(bold)Checking completeness of man page...$(normal)"
@tests/manpage_completion_test.py
@echo
test: test_py test_shellcheck
@echo "$(bold)Finished testing: All tests passed!$(normal)"
doc/ranger.1: doc/ranger.pod README.md
pod2man --stderr --center='ranger manual' \
--date='$(NAME)-$(VERSION)' \
--release=$(shell date -u '+%Y-%m-%d') \
doc/ranger.pod doc/ranger.1
doc/rifle.1: doc/rifle.pod README.md
pod2man --stderr --center='rifle manual' \
--date='$(NAME_RIFLE)-$(VERSION_RIFLE)' \
--release=$(shell date -u '+%Y-%m-%d') \
doc/rifle.pod doc/rifle.1
man: doc/ranger.1 doc/rifle.1
manhtml:
pod2html doc/ranger.pod --outfile=doc/ranger.1.html
cleandoc:
test -d $(DOCDIR) && rm -- $(DOCDIR)/*.html || true
snapshot:
git archive --prefix='$(NAME)-$(VERSION)/' --format=tar HEAD | gzip > $(SNAPSHOT_NAME)
dist: snapshot
todo:
@grep --color -Ion '\(TODO\|XXX\).*' -r ranger
.PHONY: clean cleandoc compile default dist doc help install man manhtml \
options snapshot test test_pylint test_flake8 test_doctest test_pytest \
test_other todo pypi_sdist
|