mirror of
https://github.com/cesanta/mongoose.git
synced 2026-10-22 11:36:21 +00:00
Deomid Ryabkov
b0a1cd7b0d
Now src contains exactly what's embedded in mongoose.c and .h, nothing more. Added `tools/amalgam.sh` to aamlgamate both files at once. There are no functional changes to mongoose.c, .h in this PR, only slight filename changes.
25 lines
978 B
Markdown
25 lines
978 B
Markdown
# Amalgamation
|
|
|
|
Mongoose is distributed as two files, `mongoose.c` and `mongoose.h` for ease of integration.
|
|
However, when developing Mongoose itself, it can be quite difficult to work with them.
|
|
Internally, these files are an _amalgamation_ of source and header modules.
|
|
This directory contains utilities to split and re-constitute amalgamated files.
|
|
|
|
Here's how `mongoose.c` can be split into its consituent parts:
|
|
```
|
|
$ tools/unamalgam.py mongoose.c
|
|
=> src/mg_internal.h
|
|
=> src/common/mg_mem.h
|
|
...
|
|
```
|
|
|
|
This produces directories and files under `mongoose/` and `common/` that are easeier to work with.
|
|
It also produces `mongoose.c.manifest` which can later be used to reconstruct the file back:
|
|
```
|
|
$ tools/amalgam.py --prefix=MG --public-header=mongoose.h $(cat mongoose.c.manifest) > mongoose.c
|
|
```
|
|
|
|
The same applies to `mongoose.h`, except `--public-header` should be omitted during amalgamation.
|
|
|
|
`tools/amalgam.sh` can be used to assemble `mongoose.c` and `mongoose.h`.
|