ralsina/tartrazine
1
0
Fork 0
mirror of https://github.com/ralsina/tartrazine.git synced 2025-05-23 16:40:08 -03:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #124 from dpordomingo/docsrv

Browse Source 
Implement Docsrv
This commit is contained in:
Alfredo Beaumont 2017-10-16 16:19:42 +02:00 committed by GitHub
commit 1c163c5dae
2 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Makefile
View File

@ -6,16 +6,21 @@ COMMANDS = cli/enry
MAKEFILE = Makefile.main MAKEFILE = Makefile.main
CI_REPOSITORY = https://github.com/src-d/ci.git CI_REPOSITORY = https://github.com/src-d/ci.git
CI_FOLDER = .ci CI_FOLDER = .ci
# If you need to build more than one dockerfile, you can do so like this:
# DOCKERFILES = Dockerfile_filename1:repositoryname1 Dockerfile_filename2:repositoryname2 ...
$(MAKEFILE): $(MAKEFILE):
@git clone --quiet $(CI_REPOSITORY) $(CI_FOLDER); \ @git clone --quiet $(CI_REPOSITORY) $(CI_FOLDER); \
cp $(CI_FOLDER)/$(MAKEFILE) .; cp $(CI_FOLDER)/$(MAKEFILE) .;
-include $(MAKEFILE) -include $(MAKEFILE)
# Docsrv: configure the languages whose api-doc can be auto generated
LANGUAGES = go
# Docs: do not edit this
DOCS_REPOSITORY := https://github.com/src-d/docs
SHARED_PATH ?= $(shell pwd)/.shared
DOCS_PATH ?= $(SHARED_PATH)/.docs
$(DOCS_PATH)/Makefile.inc:
git clone --quiet --depth 1 $(DOCS_REPOSITORY) $(DOCS_PATH);
-include $(DOCS_PATH)/Makefile.inc
LINGUIST_PATH = .linguist LINGUIST_PATH = .linguist
# build CLI # build CLI

6
README.md
View File

@ -120,7 +120,7 @@ Note that even if enry's CLI is compatible with linguist's, its main point is th
Java bindings Java bindings
------------ ------------
Generated Java binidings using a C shared library + JNI are located under [`java`](java) Generated Java binidings using a C shared library + JNI are located under [`java`](https://github.com/src-d/enry/blob/master/java)
Development Development
------------ ------------
@ -141,7 +141,7 @@ So we update the generated code as needed, without any specific criteria.
If you want to update *enry* because of changes in linguist, you can run the *go If you want to update *enry* because of changes in linguist, you can run the *go
generate* command and do a pull request that only contains the changes in generate* command and do a pull request that only contains the changes in
generated files (those files in the subdirectory [data](data)). generated files (those files in the subdirectory [data](https://github.com/src-d/enry/blob/master/data)).
To run the tests, To run the tests,
@ -185,7 +185,7 @@ We found some few cases where enry turns slower than linguist. This is due to
Golang's regexp engine being slower than Ruby's, which uses the [oniguruma](https://github.com/kkos/oniguruma) library, written in C. Golang's regexp engine being slower than Ruby's, which uses the [oniguruma](https://github.com/kkos/oniguruma) library, written in C.
You can find scripts and additional information (like software and hardware used You can find scripts and additional information (like software and hardware used
and benchmarks' results per sample file) in [*benchmarks*](benchmarks) directory. and benchmarks' results per sample file) in [*benchmarks*](https://github.com/src-d/enry/blob/master/benchmarks) directory.
If you want to reproduce the same benchmarks you can run: If you want to reproduce the same benchmarks you can run: