\label{doc_api_review_core_keyAddName_md_md_doc_api_review_core_keyAddName}%
\Hypertarget{doc_api_review_core_keyAddName_md_md_doc_api_review_core_keyAddName}%

\begin{DoxyItemize}
\item start = 2021-\/02-\/26 12\+:25
\item end = 2021-\/02-\/26 18\+:10
\item moderator = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\item reviewer = Michael Tucek \href{mailto:michael@tucek.eu}{\texttt{ michael@tucek.\+eu}}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyAddName_md_autotoc_md709}{}\doxysection{Signature}\label{doc_api_review_core_keyAddName_md_autotoc_md709}
{\ttfamily ssize\+\_\+t \mbox{\hyperlink{group__keyname_gaa70593a2c772c4b7bc33423b9b10a270}{key\+Add\+Name(\+Key $\ast$key, const char $\ast$add\+Name)}}}\hypertarget{doc_api_review_core_keyAddName_md_autotoc_md710}{}\doxysection{Checklist}\label{doc_api_review_core_keyAddName_md_autotoc_md710}
\hypertarget{doc_api_review_core_keyAddName_md_autotoc_md711}{}\doxysubsubsection{Doxygen}\label{doc_api_review_core_keyAddName_md_autotoc_md711}
(bullet points are in order of appearance)


\begin{DoxyItemize}
\item \mbox{[} \mbox{]} First line explains briefly what the function does ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Add an already escaped key name part to the key name
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Simple example or snippet how to use the function ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add very simple example, with one simple key name part without dots
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Longer description of function containing common use cases ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add common use cases (append to a key name,..)
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Description of functions reads nicely ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} move examples to bottom ~\newline

\item \mbox{[} \mbox{]} passed name below brief description ~\newline

\item \mbox{[} \mbox{]} replace list with reference to canonicalization docs ~\newline

\item \mbox{[} \mbox{]} \textquotesingle{}key name\textquotesingle{} rules no space before dot
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @pre} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} move above {\ttfamily @param} ~\newline

\item \mbox{[} \mbox{]} writeable key ~\newline

\item \mbox{[} \mbox{]} new\+Name must be a valid name (reference to key name rules) ~\newline

\item \mbox{[} \mbox{]} move \char`\"{}\+It is not allowed to\char`\"{} precondition
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @post} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} new\+Name has been added to key
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @invariant} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @param} for every parameter ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} move below {\ttfamily @pre} ~\newline

\item \mbox{[} \mbox{]} key -\/ pointer to Key object ~\newline

\item \mbox{[} \mbox{]} new\+Name -\/ name part to append to {\ttfamily key}\textquotesingle{}s name
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @return} / {\ttfamily @retval} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} move below {\ttfamily @param} ~\newline

\item \mbox{[} \mbox{]} move {\ttfamily @retval} into list ~\newline

\item \mbox{[} \mbox{]} make error cases differentiable (key errors, name errors)?
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @since} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} move lower
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} {\ttfamily @ingroup}
\item \mbox{[} \mbox{]} {\ttfamily @see} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily \mbox{\hyperlink{group__keyname_gaa942091fc4bd5c2699e49ddc50829524}{key\+Add\+Base\+Name()}}} ~\newline

\item \mbox{[} \mbox{]} {\ttfamily \mbox{\hyperlink{group__keyname_ga7699091610e7f3f43d2949514a4b35d9}{key\+Set\+Name()}}} ~\newline

\item \mbox{[} \mbox{]} {\ttfamily \mbox{\hyperlink{group__keyname_ga6e804bd453f98c28b0ff51430d1df407}{key\+Set\+Base\+Name()}}}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyAddName_md_autotoc_md712}{}\doxysubsection{Naming}\label{doc_api_review_core_keyAddName_md_autotoc_md712}

\begin{DoxyItemize}
\item Abbreviations used in function names must be defined in the \mbox{\hyperlink{doc_help_elektra-glossary_md}{Glossary}}
\item \mbox{[}x\mbox{]} Function names should neither be too long, nor too short
\item \mbox{[} \mbox{]} Function name should be clear and unambiguous ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Add -\/$>$ Append
\end{DoxyItemize}
\item Abbreviations used in parameter names must be defined in the \mbox{\hyperlink{doc_help_elektra-glossary_md}{Glossary}}
\item \mbox{[}x\mbox{]} Parameter names should neither be too long, nor too short
\item \mbox{[} \mbox{]} Parameter names should be clear and unambiguous ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} new\+Name -\/$>$ name\+Parts
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyAddName_md_autotoc_md713}{}\doxysubsection{Compatibility}\label{doc_api_review_core_keyAddName_md_autotoc_md713}
(only in PRs)


\begin{DoxyItemize}
\item \mbox{\hyperlink{doc_dev_symbol-versioning_md}{Symbol versioning}} is correct for breaking changes
\item ABI/\+API changes are forward-\/compatible (breaking backwards-\/compatibility to add additional symbols is fine)
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyAddName_md_autotoc_md714}{}\doxysubsection{Parameter \& Return Types}\label{doc_api_review_core_keyAddName_md_autotoc_md714}

\begin{DoxyItemize}
\item Function parameters should use enum types instead of boolean types wherever sensible
\item \mbox{[}x\mbox{]} Wherever possible, function parameters should be {\ttfamily const}
\item \mbox{[}x\mbox{]} Wherever possible, return types should be {\ttfamily const}
\item \mbox{[}x\mbox{]} Functions should have the least amount of parameters feasible
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyAddName_md_autotoc_md715}{}\doxysubsection{Structural Clarity}\label{doc_api_review_core_keyAddName_md_autotoc_md715}

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Functions should do exactly one thing
\item \mbox{[}x\mbox{]} Function name has the appropriate prefix
\item \mbox{[} \mbox{]} Order of signatures in kdb.\+h.\+in is the same as Doxygen ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} order is different
\end{DoxyItemize}
\item \mbox{[} \mbox{]} No functions with similar purpose exist ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily \mbox{\hyperlink{group__keyname_gaa70593a2c772c4b7bc33423b9b10a270}{key\+Add\+Name()}}} merge with {\ttfamily \mbox{\hyperlink{group__keyname_ga7699091610e7f3f43d2949514a4b35d9}{key\+Set\+Name()}}}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyAddName_md_autotoc_md716}{}\doxysubsection{Memory Management}\label{doc_api_review_core_keyAddName_md_autotoc_md716}

\begin{DoxyItemize}
\item Memory Management should be handled by the function wherever possible
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyAddName_md_autotoc_md717}{}\doxysubsection{Extensibility}\label{doc_api_review_core_keyAddName_md_autotoc_md717}

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Function is easily extensible, e.\+g., with flags
\item \mbox{[}x\mbox{]} Documentation does not impose limits, that would hinder further extensions
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyAddName_md_autotoc_md718}{}\doxysubsection{Tests}\label{doc_api_review_core_keyAddName_md_autotoc_md718}

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Function code is fully covered by tests ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} check if we can remove uncovered code ~\newline

\item \mbox{[}x\mbox{]} Line 542
\end{DoxyItemize}
\item \mbox{[} \mbox{]} All possible error states are covered by tests ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} add test case for read-\/only key ~\newline

\item \mbox{[}x\mbox{]} test invalid name
\end{DoxyItemize}
\item All possible enum values are covered by tests
\item \mbox{[}x\mbox{]} No inconsistencies between tests and documentation
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyAddName_md_autotoc_md719}{}\doxysection{Summary}\label{doc_api_review_core_keyAddName_md_autotoc_md719}
\hypertarget{doc_api_review_core_keyAddName_md_autotoc_md720}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_api_review_core_keyAddName_md_autotoc_md720}

\begin{DoxyItemize}
\item What is a valid Key exactly? Or does it just mean a valid pointer?
\item Different Return Vlaues for different errors
\item Set Doxygen Options to sort after header file 
\end{DoxyItemize}