More cli support #18
Open
More cli support #18
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This pull request has grown somewhat large. |
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
outscale-mgo
force-pushed
the
more-cli-support
branch
from
de0a053 to
3d9786e
Compare
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
HACKING.md
Outdated
| @@ -2,6 +2,13 @@ | |||
|
|
|||
| *Essential Information for Hacking COGNAC* | |||
|
|
|||
| ## Enabling debug | |||
HACKING.md
Outdated
| @@ -2,6 +2,13 @@ | |||
|
|
|||
| *Essential Information for Hacking COGNAC* | |||
|
|
|||
| ## Enabling debug | |||
|
|
|||
| To enable debug, use `--debug-mode` in `./configure` | |||
There was a problem hiding this comment.
To enable debug mode, use the --debug-mode option with the ./configure command
HACKING.md
Outdated
| To enable debug, use `--debug-mode` in `./configure` | ||
|
|
||
| then the `debug` commande in the shell script will print some information. | ||
| without this option debug will print nothing |
There was a problem hiding this comment.
Once enabled, the debug command in the shell script will print debug information. Without this option, the debug command will not output any information.
HACKING.md
Outdated
| @@ -35,6 +42,28 @@ A relatively easy way to add a feature in Cognac is to start by modifying the ge | |||
|
|
|||
| For exemple, if you modify a function like `parse_thatarg()` in "osc_sdk.c", once the changes are working, you can then search (using a tool like grep) through the generator code to find where `parse_thatarg` is generated. From there, you can add modifications to the generator to make the change permanent and automated. | |||
|
|
|||
| ## Example to add a new API, that doesn't work at first. | |||
There was a problem hiding this comment.
Example: Adding a New API That Initially Doesn't Work
HACKING.md
Outdated
| @@ -35,6 +42,28 @@ A relatively easy way to add a feature in Cognac is to start by modifying the ge | |||
|
|
|||
| For exemple, if you modify a function like `parse_thatarg()` in "osc_sdk.c", once the changes are working, you can then search (using a tool like grep) through the generator code to find where `parse_thatarg` is generated. From there, you can add modifications to the generator to make the change permanent and automated. | |||
|
|
|||
| ## Example to add a new API, that doesn't work at first. | |||
|
|
|||
| Let's say you ahve configure cognac like this | |||
There was a problem hiding this comment.
Let's say you have configured Cognac like this:
bin/README.md
Outdated
| `path`, if the argument is use in the path | ||
| `header` if it is an http header | ||
| `query` if it is in a query string | ||
| `data` if it is use in post data |
There was a problem hiding this comment.
Return where the argument is used:
path: If the argument is used in the URL path.header: If the argument is used as an HTTP header.query: If the argument is in a query string.data: If the argument is used in POST data.
bin/README.md
Outdated
|
|
||
| # construct_path | ||
|
|
||
| generate the C code to create a osc_str that the path of the call. |
There was a problem hiding this comment.
Generate the C code to create an osc_str for the path of the call.
bin/README.md
Outdated
| osc_str_append_string(&end_call, "/get"); | ||
| ``` | ||
|
|
||
| The code generated is not exhaustive, but you get the idea. |
There was a problem hiding this comment.
The generated code is not exhaustive, but it conveys the general idea.
configure
Outdated
| --debug-mode enable debug in cognac (output on stderr) | ||
| --function-suffix=suffix suffix use to find function in componants, default: Request | ||
| --funclist-arg=arg arguments to pass to funclist | ||
| --from-path use paths instead of componant suffix for functions generations |
There was a problem hiding this comment.
--from-path: Uses paths instead of component suffixes for function generation.
| @@ -28,6 +33,11 @@ for arg in $@; do | |||
| --wget-json-search wget json-search.Appimage | |||
| --gnu-sed-alias use gsed for sed | |||
| --cli-name=Name set cli name, default: oapi-cli | |||
| --sdk-name=name set sdk Name, default: osc-sdk | |||
| --debug-mode enable debug in cognac (output on stderr) | |||
| --function-suffix=suffix suffix use to find function in componants, default: Request | |||
There was a problem hiding this comment.
--function-suffix=suffix: Suffix used to identify functions in components. Default:
Signed-off-by: Matthias Gatto <[email protected]>
Signed-off-by: Matthias Gatto <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.