Skip to content

Commit

Permalink
Merge pull request #4810 from atmaxinger/glossary
Browse files Browse the repository at this point in the history
doc: add glossaries for contrib and dev
  • Loading branch information
atmaxinger committed Jul 18, 2023
2 parents 6fe5335 + 60d6768 commit 49b53f4
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 1 deletion.
1 change: 1 addition & 0 deletions doc/contrib/README.md
@@ -1,6 +1,7 @@
This folder contains information for contributors to Elektra.

- [Documentation Guidelines](documentation.md)
- [Contributor's Glossary](contrib-glossary.md)
- [Copy on Write](copy_on_write.md)
- [mmapstorage](mmapstorage.md)
- [Session Recording](recording.md)
Expand Down
4 changes: 4 additions & 0 deletions doc/contrib/contrib-glossary.md
@@ -0,0 +1,4 @@
# Contributor's glossary of Elektra

- **Change Tracking**:
mechanism to detect changes that were made to keys in between `kdbGet` and `kdbSet` calls
1 change: 1 addition & 0 deletions doc/dev/README.md
Expand Up @@ -6,6 +6,7 @@ It complements the man pages found [here](/doc/help).
- [Architecture](architecture.md)
- [Classes](classes.md)
- [Data structures](data-structures.md)
- [Developers's Glossary](dev-glossary.md)
- [Plugins Framework](plugins-framework.md)
- [History](history.md)

Expand Down
1 change: 1 addition & 0 deletions doc/dev/dev-glossary.md
@@ -0,0 +1 @@
# Developer's glossary of Elektra
4 changes: 4 additions & 0 deletions doc/help/elektra-glossary.md
Expand Up @@ -59,6 +59,10 @@
A library may implement several classes.
E.g., `KDB`, `Key` and `KeySet` are the most important classes.

- **Hooks**:
Central points in the KDB lifecycle, where specialized plugins are called.
Can be used for notification and other purposes.

## Technical Concepts

- [Backends](elektra-backends.md):
Expand Down
2 changes: 1 addition & 1 deletion doc/news/_preparation_next_release.md
Expand Up @@ -348,6 +348,7 @@ This section keeps you up-to-date with the multi-language support provided by El
- <<TODO>>
- Update release documentation regarding version tags. _(Mihael Pranjić @mpranj)_
- <<TODO>>
- Add glossaries for [developers](/doc/dev/dev-glossary.md) and [contributors](/doc/contrib/contrib-glossary.md) _(Maximilian Irlinger @atmaxinger)_
- <<TODO>>
- <<TODO>>
- <<TODO>>
Expand Down Expand Up @@ -388,7 +389,6 @@ This section keeps you up-to-date with the multi-language support provided by El
- <<TODO>>
- <<TODO>>
- <<TODO>>
- <<TODO>>

### Decisions

Expand Down

0 comments on commit 49b53f4

Please sign in to comment.