Fix typos in documentation (codespell)

[apt.git] / apt-pkg / contrib / error.h

diff --git a/apt-pkg/contrib/error.h b/apt-pkg/contrib/error.h
index 73735162ddc0d77f9faad7a3f7bc6873926ca22d..bcee70b1adaa5ee94c1763f260fda00c8ef4d6c7 100644 (file)
--- a/apt-pkg/contrib/error.h
+++ b/apt-pkg/contrib/error.h
@@ -114,6 +114,34 @@ public:                                                                    /*{{{*/
         */
        bool DebugE(const char *Function,const char *Description,...) __like_printf(3) __cold;
 
         */
        bool DebugE(const char *Function,const char *Description,...) __like_printf(3) __cold;
 

+       /** \brief adds an errno message with the given type
+        *
+        * \param type of the error message
+        * \param Function which failed
+        * \param Description of the error
+        */
+       bool InsertErrno(MsgType const &type, const char* Function,
+                        const char* Description,...) __like_printf(4) __cold;
+
+       /** \brief adds an errno message with the given type
+        *
+        * args needs to be initialized with va_start and terminated
+        * with va_end by the caller. msgSize is also an out-parameter
+        * in case the msgSize was not enough to store the complete message.
+        *
+        * \param type of the error message
+        * \param Function which failed
+        * \param Description is the format string for args
+        * \param args list from a printf-like function
+        * \param errsv is the errno the error is for
+        * \param msgSize is the size of the char[] used to store message
+        * \return true if the message was added, false if not - the caller
+        * should call this method again in that case
+        */
+       bool InsertErrno(MsgType type, const char* Function,
+                        const char* Description, va_list &args,
+                        int const errsv, size_t &msgSize);
+

        /** \brief add an fatal error message to the list
         *
         *  Most of the stuff we consider as "error" is also "fatal" for
        /** \brief add an fatal error message to the list
         *
         *  Most of the stuff we consider as "error" is also "fatal" for


@@ -169,6 +197,29 @@ public:                                                                    /*{{{*/
         */
        bool Debug(const char *Description,...) __like_printf(2) __cold;
 
         */
        bool Debug(const char *Description,...) __like_printf(2) __cold;
 

+       /** \brief adds an error message with the given type
+        *
+        * \param type of the error message
+        * \param Description of the error
+        */
+       bool Insert(MsgType const &type, const char* Description,...) __like_printf(3) __cold;
+
+       /** \brief adds an error message with the given type
+        *
+        * args needs to be initialized with va_start and terminated
+        * with va_end by the caller. msgSize is also an out-parameter
+        * in case the msgSize was not enough to store the complete message.
+        *
+        * \param type of the error message
+        * \param Description is the format string for args
+        * \param args list from a printf-like function
+        * \param msgSize is the size of the char[] used to store message
+        * \return true if the message was added, false if not - the caller
+        * should call this method again in that case
+        */
+       bool Insert(MsgType type, const char* Description,
+                        va_list &args, size_t &msgSize) __cold;
+

        /** \brief is an error in the list?
         *
         *  \return \b true if an error is included in the list, \b false otherwise
        /** \brief is an error in the list?
         *
         *  \return \b true if an error is included in the list, \b false otherwise


@@ -178,7 +229,7 @@ public:                                                                     /*{{{*/
        /** \brief is the list empty?
         *
         *  The default checks if the list is empty or contains only notices,
        /** \brief is the list empty?
         *
         *  The default checks if the list is empty or contains only notices,

-        *  if you want to check if also no notices happend set the parameter
+        *  if you want to check if also no notices happened set the parameter

         *  flag to \b false.
         *
         *  \param WithoutNotice does notices count, default is \b true, so no
         *  flag to \b false.
         *
         *  \param WithoutNotice does notices count, default is \b true, so no


@@ -204,9 +255,10 @@ public:                                                                    /*{{{*/
         *  displayed or not.
         *
         *  \param[out] out output stream to write the messages in
         *  displayed or not.
         *
         *  \param[out] out output stream to write the messages in

-        *  \param WithoutNotice output notices or not
+        *  \param threshold minimim level considered
+         *  \param mergeStack 

         */
         */

-       void DumpErrors(std::ostream &out, MsgType const &trashhold = WARNING,
+       void DumpErrors(std::ostream &out, MsgType const &threshold = WARNING,

                        bool const &mergeStack = true);
 
        /** \brief dumps the list of messages to std::cerr
                        bool const &mergeStack = true);
 
        /** \brief dumps the list of messages to std::cerr


@@ -214,10 +266,22 @@ public:                                                                   /*{{{*/
         *  Note that all messages are discarded, also the notices
         *  displayed or not.
         *
         *  Note that all messages are discarded, also the notices
         *  displayed or not.
         *

-        *  \param WithoutNotice print notices or not
+        *  \param threshold minimum level printed
+        */
+       void inline DumpErrors(MsgType const &threshold) {
+               DumpErrors(std::cerr, threshold);
+       }
+
+        // mvo: we do this instead of using a default parameter in the
+        //      previous declaration to avoid a (subtle) API break for
+        //      e.g. sigc++ and mem_fun0
+       /** \brief dumps the messages of type WARNING or higher to std::cerr
+        *
+        *  Note that all messages are discarded, displayed or not.
+        *

         */
         */

-       void inline DumpErrors(MsgType const &trashhold = WARNING) {
-               DumpErrors(std::cerr, trashhold);
+       void inline DumpErrors() {
+                DumpErrors(WARNING);

        }
 
        /** \brief put the current Messages into the stack
        }
 
        /** \brief put the current Messages into the stack


@@ -276,11 +340,6 @@ private:                                                           /*{{{*/
        };
 
        std::list<MsgStack> Stacks;
        };
 
        std::list<MsgStack> Stacks;

-
-       bool InsertErrno(MsgType type, const char* Function,
-                        const char* Description, va_list const &args);
-       bool Insert(MsgType type, const char* Description,
-                        va_list const &args);

                                                                        /*}}}*/
 };
                                                                        /*}}}*/
                                                                        /*}}}*/
 };
                                                                        /*}}}*/