\label{doc_api_review_core_keyAddBaseName_md_md_doc_api_review_core_keyAddBaseName}%
\Hypertarget{doc_api_review_core_keyAddBaseName_md_md_doc_api_review_core_keyAddBaseName}%

\begin{DoxyItemize}
\item start = 2021-\/03-\/04 21\+:35
\item end = 2021-\/03-\/04 22\+:00
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyAddBaseName_md_autotoc_md719}{}\doxysection{Signature}\label{doc_api_review_core_keyAddBaseName_md_autotoc_md719}
{\ttfamily ssize\+\_\+t \mbox{\hyperlink{group__keyname_gaa942091fc4bd5c2699e49ddc50829524}{key\+Add\+Base\+Name(\+Key $\ast$key,const char $\ast$base\+Name)}}}\hypertarget{doc_api_review_core_keyAddBaseName_md_autotoc_md720}{}\doxysection{Checklist}\label{doc_api_review_core_keyAddBaseName_md_autotoc_md720}
\hypertarget{doc_api_review_core_keyAddBaseName_md_autotoc_md721}{}\doxysubsubsection{Doxygen}\label{doc_api_review_core_keyAddBaseName_md_autotoc_md721}
(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{]} Adds -\/$>$ Appends
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Simple example or snippet how to use the function ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} move below brief description
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Longer description of function containing common use cases ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add notice for read-\/only keys
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Description of functions reads nicely ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Add comma after \char`\"{}\+When base\+Name is 0\char`\"{} ~\newline

\item \mbox{[} \mbox{]} 0 -\/$>$ null pointer
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @pre} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @post} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @invariant} ~\newline

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

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add read-\/only case
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @since} ~\newline

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

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} move to bottom
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyAddBaseName_md_autotoc_md722}{}\doxysubsection{Naming}\label{doc_api_review_core_keyAddBaseName_md_autotoc_md722}

\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{[}x\mbox{]} Function name should be clear and unambiguous
\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{[}x\mbox{]} Parameter names should be clear and unambiguous
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyAddBaseName_md_autotoc_md723}{}\doxysubsection{Compatibility}\label{doc_api_review_core_keyAddBaseName_md_autotoc_md723}
(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_keyAddBaseName_md_autotoc_md724}{}\doxysubsection{Parameter \& Return Types}\label{doc_api_review_core_keyAddBaseName_md_autotoc_md724}

\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_keyAddBaseName_md_autotoc_md725}{}\doxysubsection{Structural Clarity}\label{doc_api_review_core_keyAddBaseName_md_autotoc_md725}

\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{]} swapped with {\ttfamily key\+Set\+Base\+Name}
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} No functions with similar purpose exist
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyAddBaseName_md_autotoc_md726}{}\doxysubsection{Memory Management}\label{doc_api_review_core_keyAddBaseName_md_autotoc_md726}

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Memory Management should be handled by the function wherever possible
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyAddBaseName_md_autotoc_md727}{}\doxysubsection{Extensibility}\label{doc_api_review_core_keyAddBaseName_md_autotoc_md727}

\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_keyAddBaseName_md_autotoc_md728}{}\doxysubsection{Tests}\label{doc_api_review_core_keyAddBaseName_md_autotoc_md728}

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Function code is fully covered by tests
\item \mbox{[}x\mbox{]} All possible error states are covered by tests
\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_keyAddBaseName_md_autotoc_md729}{}\doxysection{Summary}\label{doc_api_review_core_keyAddBaseName_md_autotoc_md729}
\hypertarget{doc_api_review_core_keyAddBaseName_md_autotoc_md730}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_api_review_core_keyAddBaseName_md_autotoc_md730}
