Commit 0e2dffad authored by mohseenrm's avatar mohseenrm

Adding review changes

parent 71685d76
## /generate
The scripts and templates in this dir, help generate the source code and tests for NodeGit. The major components of generate are:
The scripts and templates in this dir help generate the source code and tests for NodeGit. The major components of generate are:
1. Input
2. Scripts
......
......@@ -4,22 +4,20 @@
## Why?
If generated code does not accurately wrap the libgit2 calls, you might want to consider implementing manual templates in the following cases:
#### 1. Performance
> Everytime the library switches between the C land and the JS queue thread, there is a penalty in performance. If the generated code switches frequently, it might be better option to use manual templates.
> Everytime the library switches between C land and the javascript thread, there is a penalty in performance. If in practice the usage of a method in libgit2 requires crossing the c/javascript boundary frequently, it might be better option to use manual templates. An example being ```Revwalk::FastWalk```.
#### 2. Saftey
> The generated code sometimes does not handle structures that are inter-dependant. Perfect example would be convenient_hunks. Hunks references a file pointer and diff lines that are dependant on it. If persisted, it would lock the file. If garbage collected, the diff lines would cause seg fault errors. Anytime a custom solution is required, that would be hard for generated code to implement, manual templates should be used.
> The generated code sometimes does not handle structures that are interdependent. An example would be ```git_patch``` and ```git_diff```. A ```git_patch```'s memory is owned by ```git_diff```, and that includes all of the children of ```git_patch```, as well. So a ```git_diff_hunk```, ```git_diff_line```, and ```git_patch``` all are owned by a ```git_diff```, and when that ```git_diff``` is deleted, all the memory for any patches, hunks, or lines that are in use as NodeGitWrappers are now corrupted. Further, a ```git_diff``` keeps a file handle open for its entire lifespan, which can lead to NodeGit holding onto file locks in Windows. Due to both of these compounding issues, we wrote manual templates to shift ownership away from a ```git_diff``` to ```git_patch```, ```git_diff_hunk```, and ```git_diff_line``` and also shorten the lifespan of a diff.
#### 3. Odd cases
> If a new pattern exists in libgit that would be difficult to implement using generated code, manual templates can be used for one-off cases. Typically generated code takes care of most patterns seen in libgit, but if function signatures do not follow typical pattern, manual templates could be used. Example: git_filter.
> If a new pattern exists in libgit that would be difficult to implement using generated code, manual templates can be used for one-off cases. Typically generated code takes care of most patterns seen in libgit, but if function signatures do not follow typical pattern, manual templates could be used. Example: ```git_filter``` and ```git_remote_ls```.
<br />
-----
## Implementing manual templates
#### 1. Copy generated .cc and .h files to *generate/templates/manual/*
#### 1. Write manual .cc and .h files to *generate/templates/manual/*
*.cc files -> /generate/templates/manual/src/
*.h files -> /generate/templates/manual/include/
......
## /lib
Contains wrappers to abstract the internals of the JavaScript part of NodeGit Module.
Contains javascript extensions for the generated NodeGit modules. Any additional behavior on top of the standard libgit2 behavior will be found here.
## /lifecycleScripts
These scripts are responsible for downloading the right dependencies, configuring vendors, and all other dependencies that are required to build, generate and clean the module.
These scripts are responsible for downloading the right dependencies, configuring vendors, and all other dependencies that are required to build, generate, and clean the module.
\ No newline at end of file
## /test
Contains all the test scripts, runner and keys for running the tests.
Contains all the test scripts, runner, and keys for running the tests.
-----------
#### /home
contains gitconfig for the test repositories.
Contains gitconfig for the test repositories.
#### /repos
contains blame, empty, nonrepo and workdir test repositories.
Contains blame, empty, nonrepo, and workdir test repositories.
#### /tests
unit tests for NodeGit.
Unit tests for NodeGit.
#### /utils
test utilities with garbage collector, index and repository setup, that can be used in tests.
Test utilities with garbage collector, index, and repository setup, that can be used in tests.
## /utils
contains utilities for NodeGit
Contains utilities for NodeGit
#### buildFlags
determines how NodeGit should build. Use `BUILD_ONLY` environment variable to build from source.
Determines how NodeGit should build. Use `BUILD_ONLY` environment variable to build from source.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment