Skip to content

Commit 515688b

Browse files
committed
revert: "Merge branch 'refactor/zinit-function-names' into main"
This reverts commit b979847, reversing changes made to da924a2. I (@vladdoster) accidentally merged this into the wrong repository. Apologies for the lack of due diligence.
1 parent b979847 commit 515688b

36 files changed

+5461
-5944
lines changed

.dockerignore

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,10 @@
1+
.git/
2+
.github/
3+
.git*
4+
doc/
5+
scripts/
6+
test/
7+
tests/
8+
19
*.zwc
10+
Makefile

.github/workflows/documentation.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ jobs:
1515
zshelldoc:
1616
runs-on: ubuntu-latest
1717
steps:
18+
1819
- name: checkout repository
1920
uses: actions/checkout@v3
2021

21-
- name: build docker image
22-
run: make container-build
23-
24-
- name: generate documentation
25-
run: make container-docs
22+
- name: re-generate documentation
23+
run: |
24+
make doc/container
25+
sudo chown -R "$(id -u):$(id -g)" .
2626
2727
- name: check for out-of-date documentation
2828
run: |

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
* change ctags symbols browser key binding from `ctrl-k` to `alt-Q` ([#387](https://github.com/zdharma-continuum/zinit/issues/387)) ([7f6dc7d](https://github.com/zdharma-continuum/zinit/commit/7f6dc7da6c824b30c0e8e30ae0ecbda5be118e68)), closes [#386](https://github.com/zdharma-continuum/zinit/issues/386)
3535
* Do not try to escape exclamation marks ([#399](https://github.com/zdharma-continuum/zinit/issues/399)) ([0e55b2e](https://github.com/zdharma-continuum/zinit/commit/0e55b2ea673915c462af752ee7d46fff55e6f436))
3636
* docs workflow should fail if out-of-date ([#278](https://github.com/zdharma-continuum/zinit/issues/278)) ([07cde66](https://github.com/zdharma-continuum/zinit/commit/07cde660081c91382ce73b60485839710154c7c6))
37-
* Don't error if $OPTS is not yet defined in zi::compinit call ([44765e0](https://github.com/zdharma-continuum/zinit/commit/44765e0bcb8d3f1ee3eb55286e33ad17b8c72a5e))
37+
* Don't error if $OPTS is not yet defined in .zinit-compinit call ([44765e0](https://github.com/zdharma-continuum/zinit/commit/44765e0bcb8d3f1ee3eb55286e33ad17b8c72a5e))
3838
* filter by runtime detected CPU before compiled CPU ([#304](https://github.com/zdharma-continuum/zinit/issues/304)) ([a4dc13f](https://github.com/zdharma-continuum/zinit/commit/a4dc13f66a65c4fa52953104c13e44a7d7c0a945)), closes [#287](https://github.com/zdharma-continuum/zinit/issues/287)
3939
* gh-r & plugin zunit tests ([dd12fce](https://github.com/zdharma-continuum/zinit/commit/dd12fce3f49db284de7cf18a03ef891cc46bc7cc))
4040
* gh-r filters i686 (32 bit) for x86_64 ([#226](https://github.com/zdharma-continuum/zinit/issues/226)) ([57f0d82](https://github.com/zdharma-continuum/zinit/commit/57f0d82118ed626f04d4b9b8b26de48c9d7e0956)), closes [#225](https://github.com/zdharma-continuum/zinit/issues/225)

Dockerfile

Lines changed: 0 additions & 25 deletions
This file was deleted.

Makefile

Lines changed: 16 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,27 @@
11
.EXPORT_ALL_VARIABLES:
22

33
ZSH := $(shell command -v zsh 2> /dev/null)
4-
SRC := share/{'git-process-output','rpm2cpio'}.zsh zinit{'','-additional','-autoload','-install','-side'}.zsh
4+
SRC := zinit{'','-additional','-autoload','-install','-side'}.zsh
55
DOC_SRC := $(foreach wrd,$(SRC),../$(wrd))
6-
HAS_TTY := $(shell [[ -z $$GITHUB_ACTIONS ]] && echo '--tty')
76

8-
.PHONY: all clean container-build container-shell container-docs tags tags/emacs tags/vim test zwc
9-
10-
all: help
7+
.PHONY: all clean container doc doc/container tags tags/emacs tags/vim test zwc
118

129
clean:
1310
rm -rvf *.zwc doc/zsdoc/zinit{'','-additional','-autoload','-install','-side'}.zsh.adoc doc/zsdoc/data/
1411

15-
doc: clean ## Generate zinit documentation
16-
cd doc; zsh -l -d -f -i -c "zsd -v --scomm --cignore '(\#*FUNCTION:[[:space:]][\+\@\-\:\_\_a-zA-Z0-9]*[\[]*|}[[:space:]]\#[[:space:]][\]]*|\#[[:space:]][\]]*)' $(DOC_SRC); make -C ./zsdoc pdf"
17-
18-
CONTAINER_NAME := zinit
19-
CONTAINER_CMD := docker run --interactive --mount=source=$(CONTAINER_NAME)-volume,destination=/root --platform=linux/x86_64 $(HAS_TTY)
12+
container:
13+
docker build --tag=ghcr.io/zdharma-continuum/zinit:latest --file=docker/Dockerfile .
2014

21-
container-build: ## build docker image
22-
docker build --file=Dockerfile --platform=linux/x86_64 --tag=$(CONTAINER_NAME):latest .
15+
doc: clean
16+
cd doc; zsh -l -d -f -i -c "zsd -v --scomm --cignore '(\#*FUNCTION:[[:space:]][\:\∞\.\+\@\-a-zA-Z0-9]*[\[]*|}[[:space:]]\#[[:space:]][\]]*)' $(DOC_SRC)"
2317

24-
container-docs: ## regenerate zinit docs in container
25-
$(CONTAINER_CMD) $(CONTAINER_NAME):latest make --directory zinit.git/ doc
18+
doc/container: container
19+
./scripts/docker-run.sh --docs --debug
2620

27-
container-shell: ## start shell in docker container
28-
$(CONTAINER_CMD) $(CONTAINER_NAME):latest
21+
# Run ctags to generate Emacs and Vim's format tag file.
22+
tags: tags/emacs tags/vim
2923

30-
test: ## Run zunit tests
31-
zunit run
32-
33-
zwc: ## compile zsh files via zcompile
34-
$(or $(ZSH),:) -fc 'for f in *.zsh; do zcompile -R -- $$f.zwc $$f || exit; done'
35-
36-
tags: tags/emacs tags/vim ## run ctags to generate emacs and vim's format tag file.
37-
38-
tags/emacs: ## build emacs-style ctags file
24+
tags/emacs: ## Build Emacs-style ctags file
3925
@if type ctags >/dev/null 2>&1; then \
4026
if ctags --version | grep >/dev/null 2>&1 "Universal Ctags"; then \
4127
ctags -e -R --options=share/zsh.ctags --languages=zsh \
@@ -49,7 +35,7 @@ tags/emacs: ## build emacs-style ctags file
4935
'version) utility first.\n'; \
5036
fi
5137

52-
tags/vim: ## build the vim-style ctags file
38+
tags/vim: ## Build the Vim-style ctags file
5339
@if type ctags >/dev/null 2>&1; then \
5440
if ctags --version | grep >/dev/null 2>&1 "Universal Ctags"; then \
5541
ctags --languages=zsh --maxdepth=1 --options=share/zsh.ctags --pattern-length-limit=250 -R; \
@@ -61,8 +47,8 @@ tags/vim: ## build the vim-style ctags file
6147
printf 'Error: Please install a ctags first.\n'; \
6248
fi
6349

64-
help: ## display available make targets
65-
@ # credit: tweekmonster github gist
66-
@echo "$$(grep -hE '^[a-zA-Z0-9_-]+:.*##' $(MAKEFILE_LIST) | sed -e 's/:.*##\s*/:/' -e 's/^\(.\+\):\(.*\)/\\033[36m\1\\033[m:\2/' | column -c2 -t -s : | sort)"
50+
test:
51+
zunit run
6752

68-
# vim: set fenc=utf8 ffs=unix ft=make list noet sw=4 ts=4 tw=72:
53+
zwc:
54+
$(or $(ZSH),:) -fc 'for f in *.zsh; do zcompile -R -- $$f.zwc $$f || exit; done'

doc/CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ For more details check out [PR #61](https://github.com/zdharma-continuum/zinit/p
115115
- 06-11-2021
116116

117117
- 🚧 zinit has a new home: https://github.com/zdharma-continuum/zinit
118-
- The migration from @zdharma, @Zsh-Packages and @zi::zsh is still in progress. If you are interested in helping
118+
- The migration from @zdharma, @Zsh-Packages and @zinit-zsh is still in progress. If you are interested in helping
119119
or want to let us know that a particular project is missing, please head to
120120
[I_WANT_TO_HELP](https://github.com/zdharma-continuum/I_WANT_TO_HELP/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
121121
- 📚 zinit now ensures that the man dirs under `$ZPFX/man` are created on startup. Please note that these directories

doc/zsdoc/Makefile

Lines changed: 48 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,57 @@
11
# This Makefile is to convert supplied Asciidoc files into
22
# other formats like pdf and man. The files contain Zplugin's
33
# code documentation.
4-
# *.adoc files are generated by Makefile from upper (i.e. top) directory.
5-
6-
SRC := $(shell zsh -c "echo {'git-process-output','rpm2cpio'}.zsh zinit{'','-additional','-autoload','-install','-side'}.zsh")
7-
8-
PDF_SRC := $(foreach wrd,$(SRC),$(wrd).pdf)
9-
PDF_CMD := asciidoctor -a reproducible -b pdf -r asciidoctor-pdf -D pdf
10-
11-
MAN_SRC := $(foreach wrd,$(SRC),man/$(wrd))
12-
MAN_CMD := a2x --verbose -L --doctype manpage --format manpage -D man
13-
14-
.PHONY: all clean test man pdf
15-
16-
all: clean man pdf
17-
dirs:
18-
mkdir -p man pdf
19-
20-
# Manual pages
21-
# uses a2x from asciidoc package
22-
man: dirs $(MAN_SRC)
23-
man/git-process-output.zsh:
24-
$(MAN_CMD) git-process-output.zsh.adoc
25-
man/rpm2cpio.zsh:
26-
$(MAN_CMD) rpm2cpio.zsh.adoc
27-
man/zinit-additional.zsh:
28-
$(MAN_CMD) zinit-additional.zsh.adoc
29-
man/zinit-autoload.zsh:
30-
$(MAN_CMD) zinit-autoload.zsh.adoc
31-
man/zinit-install.zsh:
32-
$(MAN_CMD) zinit-install.zsh.adoc
33-
man/zinit-side.zsh:
34-
$(MAN_CMD) zinit-side.zsh.adoc
35-
man/zinit.zsh:
36-
$(MAN_CMD) zinit.zsh.adoc
4+
#
5+
# *.adoc files are generated by Makefile from upper (i.e. top)
6+
# directory.
7+
8+
all: man pdf
9+
10+
# MANUALS
11+
# Converted with a2x from asciidoc package
12+
13+
man: man/zinit.zsh.1 man/zinit-side.zsh.1 man/zinit-install.zsh.1 man/zinit-autoload.zsh.1
14+
15+
man/zinit.zsh.1:
16+
@mkdir -p man
17+
a2x --verbose -L --doctype manpage --format manpage -D man zinit.zsh.adoc
18+
19+
man/zinit-side.zsh.1:
20+
@mkdir -p man
21+
a2x --verbose -L --doctype manpage --format manpage -D man zinit-side.zsh.adoc
22+
23+
man/zinit-install.zsh.1:
24+
@mkdir -p man
25+
a2x --verbose -L --doctype manpage --format manpage -D man zinit-install.zsh.adoc
26+
27+
man/zinit-autoload.zsh.1:
28+
@mkdir -p man
29+
a2x --verbose -L --doctype manpage --format manpage -D man zinit-autoload.zsh.adoc
3730

3831
# PDFS
39-
# uses asciidoctor not a2x (i.e. not asciidoc)
40-
pdf: dirs $(PDF_SRC)
41-
git-process-output.zsh.pdf:
42-
$(PDF_CMD) git-process-output.zsh.adoc
43-
rpm2cpio.zsh.pdf:
44-
$(PDF_CMD) rpm2cpio.zsh.adoc
45-
zinit-additional.zsh.pdf:
46-
$(PDF_CMD) zinit-additional.zsh.adoc
47-
zinit-autoload.zsh.pdf:
48-
$(PDF_CMD) zinit-autoload.zsh.adoc
49-
zinit-install.zsh.pdf:
50-
$(PDF_CMD) zinit-install.zsh.adoc
51-
zinit-side.zsh.pdf:
52-
$(PDF_CMD) zinit-side.zsh.adoc
53-
zinit.zsh.pdf:
54-
$(PDF_CMD) zinit.zsh.adoc
32+
# Uses asciidoctor not a2x (i.e. not asciidoc)
33+
34+
pdf: pdf/zinit.zsh.pdf pdf/zinit-side.zsh.pdf pdf/zinit-install.zsh.pdf pdf/zinit-autoload.zsh.pdf
35+
36+
pdf/zinit.zsh.pdf:
37+
@mkdir -p pdf
38+
asciidoctor -a reproducible -b pdf -r asciidoctor-pdf -D pdf zinit.zsh.adoc
39+
40+
pdf/zinit-side.zsh.pdf:
41+
@mkdir -p pdf
42+
asciidoctor -a reproducible -b pdf -r asciidoctor-pdf -D pdf zinit-side.zsh.adoc
43+
44+
pdf/zinit-install.zsh.pdf:
45+
@mkdir -p pdf
46+
asciidoctor -a reproducible -b pdf -r asciidoctor-pdf -D pdf zinit-install.zsh.adoc
47+
48+
pdf/zinit-autoload.zsh.pdf:
49+
@mkdir -p pdf
50+
asciidoctor -a reproducible -b pdf -r asciidoctor-pdf -D pdf zinit-autoload.zsh.adoc
5551

5652
clean:
5753
rm -rf man pdf data
5854

59-
# vim:ft=make:noet:sts=4:ts=4
55+
.PHONY: man pdf clean
56+
57+
# vim:noet:sts=8:ts=8

doc/zsdoc/git-process-output.zsh.adoc

Lines changed: 0 additions & 75 deletions
This file was deleted.
-49 KB
Binary file not shown.

doc/zsdoc/pdf/rpm2cpio.zsh.pdf

-24.7 KB
Binary file not shown.

0 commit comments

Comments
 (0)