Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for regenerating a single app's files. #9266

Merged
merged 1 commit into from
Aug 31, 2021
Merged

Update documentation for regenerating a single app's files. #9266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion scripts/tools/zap_regen_all.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,9 @@ def main():

targets = getTargets()
for target in targets:
subprocess.check_call(['./scripts/tools/zap/generate.py'] + target)
exec_list = ['./scripts/tools/zap/generate.py'] + target
logging.info("Generating target: %s" % " ".join(exec_list))
subprocess.check_call(exec_list)


if __name__ == '__main__':
Expand Down
18 changes: 9 additions & 9 deletions src/app/zap-templates/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,24 +31,24 @@ need to be updated. You can regenerate all files with:

### How to generate files for a single application

By default generated files are located in a `gen/` folder next to the
application `zap` file that has been created during the application
configuration.
By default generated files are located in a `zap-generated/` folder under
`zzz_generated/app-name/`.

The `gen/` folder content is the output of the templates listed into
The `zap-generated/` folder content is the output of the templates listed into
`app-templates.json`.

#### To generate the application `gen/` folder the command is:
#### To generate the application `zap-generated/` folder the command is:

```
./scripts/tools/zap/generate.py <path to application *.zap file>
./scripts/tools/zap/generate.py <path to application *.zap file> -o zzz_generated/app-name/zap-generated

```

For example, to generate `examples/lighting-app/lighting-common/gen/` folder the
command is:
For example, to generate the `zzz_generated/lighting-app/zap-generated/` folder
the command is:

```
./scripts/tools/zap/generate.py examples/lighting-app/lighting-common/lighting-app.zap
./scripts/tools/zap/generate.py examples/lighting-app/lighting-common/lighting-app.zap -o zzz_generated/lighting-app/zap-generated
```

### How to generate files for a single application using custom templates
Expand Down