mirror of
https://github.com/isar/libmdbx.git
synced 2024-10-30 11:29:19 +08:00
mdbx-docs: add Improvements beyond LMDB
to the main TOC.
This commit is contained in:
parent
c8cad3704e
commit
4677313feb
12
GNUmakefile
12
GNUmakefile
@ -532,7 +532,7 @@ mdbx-static.o: src/config.h src/version.c src/alloy.c $(ALLOY_DEPS) $(lastword $
|
|||||||
@echo ' CC $@'
|
@echo ' CC $@'
|
||||||
$(QUIET)$(CC) $(CFLAGS) $(MDBX_BUILD_OPTIONS) '-DMDBX_CONFIG_H="config.h"' -ULIBMDBX_EXPORTS -c src/alloy.c -o $@
|
$(QUIET)$(CC) $(CFLAGS) $(MDBX_BUILD_OPTIONS) '-DMDBX_CONFIG_H="config.h"' -ULIBMDBX_EXPORTS -c src/alloy.c -o $@
|
||||||
|
|
||||||
docs/Doxyfile: docs/Doxyfile.in src/version.c
|
docs/Doxyfile: docs/Doxyfile.in src/version.c $(lastword $(MAKEFILE_LIST))
|
||||||
@echo ' MAKE $@'
|
@echo ' MAKE $@'
|
||||||
$(QUIET)sed \
|
$(QUIET)sed \
|
||||||
-e "s|@MDBX_GIT_TIMESTAMP@|$(MDBX_GIT_TIMESTAMP)|" \
|
-e "s|@MDBX_GIT_TIMESTAMP@|$(MDBX_GIT_TIMESTAMP)|" \
|
||||||
@ -546,26 +546,26 @@ docs/Doxyfile: docs/Doxyfile.in src/version.c
|
|||||||
docs/Doxyfile.in >$@
|
docs/Doxyfile.in >$@
|
||||||
|
|
||||||
define md-extract-section
|
define md-extract-section
|
||||||
docs/__$(1).md: $(2)
|
docs/__$(1).md: $(2) $(lastword $(MAKEFILE_LIST))
|
||||||
@echo ' EXTRACT $1'
|
@echo ' EXTRACT $1'
|
||||||
$(QUIET)sed -n '/<!-- section-begin $(1) -->/,/<!-- section-end -->/p' $$< >$$@ && test -s $$@
|
$(QUIET)sed -n '/<!-- section-begin $(1) -->/,/<!-- section-end -->/p' $(2) >$$@ && test -s $$@
|
||||||
|
|
||||||
endef
|
endef
|
||||||
$(foreach section,overview mithril characteristics improvements history usage performance bindings,$(eval $(call md-extract-section,$(section),README.md)))
|
$(foreach section,overview mithril characteristics improvements history usage performance bindings,$(eval $(call md-extract-section,$(section),README.md)))
|
||||||
|
|
||||||
docs/overall.md: docs/__overview.md docs/_toc.md docs/__mithril.md docs/__history.md AUTHORS LICENSE
|
docs/overall.md: docs/__overview.md docs/_toc.md docs/__mithril.md docs/__history.md AUTHORS LICENSE $(lastword $(MAKEFILE_LIST))
|
||||||
@echo ' MAKE $@'
|
@echo ' MAKE $@'
|
||||||
$(QUIET)echo -e "\\mainpage Overall\n\\section brief Brief" | cat - $(filter %.md, $^) >$@ && echo -e "\n\n\nLicense\n=======\n" | cat AUTHORS - LICENSE >>$@
|
$(QUIET)echo -e "\\mainpage Overall\n\\section brief Brief" | cat - $(filter %.md, $^) >$@ && echo -e "\n\n\nLicense\n=======\n" | cat AUTHORS - LICENSE >>$@
|
||||||
|
|
||||||
docs/intro.md: docs/_preface.md docs/__characteristics.md docs/__improvements.md docs/_restrictions.md docs/__performance.md
|
docs/intro.md: docs/_preface.md docs/__characteristics.md docs/__improvements.md docs/_restrictions.md docs/__performance.md
|
||||||
@echo ' MAKE $@'
|
@echo ' MAKE $@'
|
||||||
$(QUIET)cat $^ | sed 's/^Performance comparison$$/Performance comparison {#performance}/' >$@
|
$(QUIET)cat $^ | sed 's/^Performance comparison$$/Performance comparison {#performance}/;s/^Improvements beyond LMDB$$/Improvements beyond LMDB {#improvements}/' >$@
|
||||||
|
|
||||||
docs/usage.md: docs/__usage.md docs/_starting.md docs/__bindings.md
|
docs/usage.md: docs/__usage.md docs/_starting.md docs/__bindings.md
|
||||||
@echo ' MAKE $@'
|
@echo ' MAKE $@'
|
||||||
$(QUIET)echo -e "\\page usage Usage\n\\section getting Building & Embedding" | cat - $^ | sed 's/^Bindings$$/Bindings {#bindings}/' >$@
|
$(QUIET)echo -e "\\page usage Usage\n\\section getting Building & Embedding" | cat - $^ | sed 's/^Bindings$$/Bindings {#bindings}/' >$@
|
||||||
|
|
||||||
doxygen: docs/Doxyfile docs/overall.md docs/intro.md docs/usage.md mdbx.h mdbx.h++ src/options.h ChangeLog.md AUTHORS LICENSE
|
doxygen: docs/Doxyfile docs/overall.md docs/intro.md docs/usage.md mdbx.h mdbx.h++ src/options.h ChangeLog.md AUTHORS LICENSE $(lastword $(MAKEFILE_LIST))
|
||||||
@echo ' RUNNING doxygen...'
|
@echo ' RUNNING doxygen...'
|
||||||
$(QUIET)rm -rf docs/html && \
|
$(QUIET)rm -rf docs/html && \
|
||||||
cat mdbx.h | tr '\n' '\r' | sed -e 's/LIBMDBX_INLINE_API\s*(\s*\([^,]\+\),\s*\([^,]\+\),\s*(\s*\([^)]\+\)\s*)\s*)\s*{/inline \1 \2(\3) {/g' | tr '\r' '\n' >docs/mdbx.h && \
|
cat mdbx.h | tr '\n' '\r' | sed -e 's/LIBMDBX_INLINE_API\s*(\s*\([^,]\+\),\s*\([^,]\+\),\s*(\s*\([^)]\+\)\s*)\s*)\s*{/inline \1 \2(\3) {/g' | tr '\r' '\n' >docs/mdbx.h && \
|
||||||
|
10
docs/_toc.md
10
docs/_toc.md
@ -1,3 +1,12 @@
|
|||||||
|
### We have migrated to a reliable trusted infrastructure
|
||||||
|
|
||||||
|
The origin for now is at
|
||||||
|
[GitFlic](https://gitflic.ru/project/erthink/libmdbx) since on
|
||||||
|
2022-04-15 the Github administration, without any warning nor
|
||||||
|
explanation, deleted _libmdbx_ along with a lot of other projects,
|
||||||
|
simultaneously blocking access for many developers. For the same reason
|
||||||
|
~~Github~~ is blacklisted forever.
|
||||||
|
|
||||||
_The Future will (be) [Positive](https://www.ptsecurity.com). Всё будет хорошо._
|
_The Future will (be) [Positive](https://www.ptsecurity.com). Всё будет хорошо._
|
||||||
|
|
||||||
\section toc Table of Contents
|
\section toc Table of Contents
|
||||||
@ -7,6 +16,7 @@ each of which is divided into several sections.
|
|||||||
|
|
||||||
1. The \ref intro
|
1. The \ref intro
|
||||||
- \ref characteristics
|
- \ref characteristics
|
||||||
|
- \ref improvements
|
||||||
- \ref restrictions
|
- \ref restrictions
|
||||||
- \ref performance
|
- \ref performance
|
||||||
2. \ref usage
|
2. \ref usage
|
||||||
|
Loading…
Reference in New Issue
Block a user