[
https://issues.apache.org/jira/browse/TS-3694?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14588653#comment-14588653
]
ASF GitHub Bot commented on TS-3694:
------------------------------------
GitHub user danobi opened a pull request:
https://github.com/apache/trafficserver/pull/227
TS-3694: Fix outdated Log::error documentation
Comment for function did not reflect code.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/danobi/trafficserver TS-3694
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/trafficserver/pull/227.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #227
----
commit 58b62e42fb0b9f1fa42c471efe1bbd25562dd5bf
Author: Daniel Xu <[email protected]>
Date: 2015-06-16T03:41:05Z
TS-3694: Fix outdated Log::error documentation
Comment for function did not reflect code.
----
> Fix function documentation to Log::error
> ----------------------------------------
>
> Key: TS-3694
> URL: https://issues.apache.org/jira/browse/TS-3694
> Project: Traffic Server
> Issue Type: Improvement
> Components: Logging
> Reporter: Daniel Xu
> Assignee: Daniel Xu
> Priority: Trivial
> Fix For: Docs
>
>
> The description for this function seems to be out of date. The note directly
> contradicts what the function actually does.
> {code:title=Log.cc|borderStyle=solid}
> /*-------------------------------------------------------------------------
> Log::error
> Make an entry into the current error log. For convenience, it is given in
> both variable argument (format, ...) and stdarg (format, va_list) forms.
> Note that Log::error could call Log::va_error after calling va_start
> so that va_error handles the statistics update. However, to make
> Log::error slightly more efficient this is not the case. The
> downside is that one has to be careful to update both functions if
> need be.
> -------------------------------------------------------------------------*/
> int
> Log::error(const char *format, ...)
> {
> va_list ap;
> int ret;
> va_start(ap, format);
> ret = Log::va_error(format, ap);
> va_end(ap);
> return ret;
> }
> {code}
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
