Improve documentation #371
Conversation
…a picture showing the running config.
|
Please, split this into 2 pull requests - 1 commit per pull request that is self-contained. Thanks ! |
jesperpedersen
added
the
documentation
|
Hi, Okay Seems that commit messages have a specific format, should I use [discussion_link] simple commit message for both of them? |
|
Yeah, that would be good, or better create a documentation issue that describes what needs to be improved - and then link to that |
| Headers are placed in `src/include/*.h` while the corresponding source files are in | ||
| `libpgagroal` | ||
|
|
||
| ### 1. `configuration.h /configuration.c` |
There was a problem hiding this comment.
Lets go with spaces between / for all
|
|
||
| ### 1. `configuration.h /configuration.c` | ||
|
|
||
| Contains configuration parsing code |
There was a problem hiding this comment.
Finish documentation with a .
| ### 3. `management.h/management.c` | ||
|
|
||
| This contains code providing boilerplate for reading and writing to sockets | ||
| e.g error recovery and connection management. |
There was a problem hiding this comment.
Hmm, this is the management interface
| These contain routines to manage two variables `message` and `data`. | ||
|
|
||
| The stated variables are global and the functions in `memory` help allocate, set and delete | ||
| the above memory. |
There was a problem hiding this comment.
This is the code that make pgagroal don't allocate memory at run-time
There was a problem hiding this comment.
Nice, I didn't realize that, this seems like a nice feature to mention in the readme
|
|
||
| ### 6. `pgagroal.h` | ||
|
|
||
| Defines mutliple things, shared memories for many other parts (`pipeline shared memory`, `promethus shared memory`) |
There was a problem hiding this comment.
This is the main file...
Spelling...
| @@ -21,7 +21,7 @@ Add a line like the following to `/etc/pgagroal/pgagroal.conf` by editing such f | |||
| metrics = 2346 | |||
| ``` | |||
|
|
|||
| Place it withingr the `[pgagroal]` section, like | |||
| Place it withing the `[pgagroal]` section, like | |||
|
Start with these, but look it all over |
|
Thanks for the review, modifying and sending as a new pr. |
|
Please, no new pull requests. Force push instead. |
|
Sorry, thought it would be easier on your side to review changes as
different pull requests.
Kind regards
…On Wed, May 3, 2023 at 4:30 PM Jesper Pedersen ***@***.***> wrote:
Please, no new pull requests. Force push instead.
https://git-scm.com/book/en/v2
—
Reply to this email directly, view it on GitHub
<#371 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/APGWKVJURIHFSI6ZR7ISOCDXEJMV7ANCNFSM6AAAAAAXONWRII>
.
You are receiving this because you were assigned.Message ID:
***@***.***>
|
|
One pull request per change - you can squash and force push in order to update the pull request. |
|
Please, reopen if you think it is necessary and it is up-to-date |
As a follow up to #368
This is separated into two commits.
The first commit adds a little extra information on setting up pgagroal to report metrics in a prometheus server and a picture of an instance running
The second is an overview of the files present in the repo and their functions and some gotchas on the way of how they interact, mainly important for developers hence lies in a new directory. It's not fully complete so additional support is welcome