From dfe90f066313f5a36e2240f7cdc5d254015b7d04 Mon Sep 17 00:00:00 2001 From: Richard Russon Date: Sat, 12 May 2018 12:02:25 +0100 Subject: [PATCH] fix some docs --- README.md | 4 ++-- conn/sasl_plain.c | 17 +++++++++++------ conn/sasl_plain.h | 17 ----------------- doc/manual.xml.head | 18 +++++++++--------- mutt_notmuch.c | 2 +- pop.c | 2 +- 6 files changed, 24 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index ff6ef9d18..8e1d78c97 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![Release](https://img.shields.io/github/release/neomutt/neomutt.svg)](https://github.com/neomutt/neomutt/releases/latest "Latest Release Notes") [![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](https://github.com/neomutt/neomutt/blob/master/COPYRIGHT.md "Copyright Statement") [![Code build](https://img.shields.io/travis/neomutt/neomutt.svg?label=code)](https://travis-ci.org/neomutt/neomutt "Latest Automatic Code Build") -[![Coverity Scan](https://img.shields.io/coverity/scan/8495.svg)](https://scan.coverity.com/projects/neomutt-neomutt "Latest Code Static Analysis) +[![Coverity Scan](https://img.shields.io/coverity/scan/8495.svg)](https://scan.coverity.com/projects/neomutt-neomutt "Latest Code Static Analysis") [![Website build](https://img.shields.io/travis/neomutt/neomutt.github.io.svg?label=website)](https://travis-ci.org/neomutt/neomutt.github.io "Latest Website Test") ## What is NeoMutt? @@ -69,7 +69,7 @@ sorted through them, fixed them up and documented them. - Releases: https://github.com/neomutt/neomutt/releases/latest - Questions/Bugs: https://github.com/neomutt/neomutt/issues - Website: https://neomutt.org -- IRC: irc://irc.freenode.net/neomutt - please be patient. +- IRC: [irc://irc.freenode.net/neomutt](https://webchat.freenode.net/ "IRC Web Client") - please be patient. We're a small group, so our answer might take some time. - Mailinglists: [neomutt-users](mailto:neomutt-users-request@neomutt.org?subject=subscribe) and [neomutt-devel](mailto:neomutt-devel-request@neomutt.org?subject=subscribe) diff --git a/conn/sasl_plain.c b/conn/sasl_plain.c index ea7a578d0..55b149948 100644 --- a/conn/sasl_plain.c +++ b/conn/sasl_plain.c @@ -31,16 +31,21 @@ #include "mutt/mutt.h" /** - * mutt_sasl_plain_msg - Create an SASL command - * @param buf Buffer to store the command - * @param buflen Length of the buffer - * @param cmd SASL command - * @param authz Authorisation - * @param user Username + * mutt_sasl_plain_msg - Construct a base64 encoded SASL PLAIN message + * @param buf Destination buffer + * @param buflen Available space in the destination buffer + * @param cmd Protocol-specific string the prepend to the PLAIN message + * @param authz Authorization identity + * @param user Authentication identity (username) * @param pass Password * @retval >0 Success, number of chars in the command string * @retval 0 Error * + * This function can be used to build a protocol-specific SASL Response message + * using the PLAIN mechanism. The protocol specific command is given in the cmd + * parameter. The function appends a space, encodes the string derived from + * authz\0user\0pass using base64 encoding, and stores the result in buf. + * * authz, user, and pass can each be up to 255 bytes, making up for a 765 bytes * string. Add the two NULL bytes in between plus one at the end and we get * 768. diff --git a/conn/sasl_plain.h b/conn/sasl_plain.h index cd1705c7e..759745842 100644 --- a/conn/sasl_plain.h +++ b/conn/sasl_plain.h @@ -25,23 +25,6 @@ #include -/** - * mutt_sasl_plain_msg - construct a base64 encoded SASL PLAIN message - * @param buf Destination buffer - * @param buflen Available space in the destination buffer - * @param cmd Protocol-specific string the prepend to the PLAIN message - * @param authz Authorization identity - * @param user Authentication identity (username) - * @param pass Password - * @retval num Bytes written to buf - * - * This function can be used to build a protocol-specific SASL Response message - * using the PLAIN mechanism. The protocol specific command is given in the cmd - * parameter. The function appends a space, encodes the string derived from - * authz\0user\0pass using base64 encoding, and stores the result in buf. - * - * Example usages for IMAP and SMTP, respectively: - */ size_t mutt_sasl_plain_msg(char *buf, size_t buflen, const char *cmd, const char *authz, const char *user, const char *pass); diff --git a/doc/manual.xml.head b/doc/manual.xml.head index 37c960a13..eec9e8cd1 100644 --- a/doc/manual.xml.head +++ b/doc/manual.xml.head @@ -7217,18 +7217,18 @@ set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s" ~h EXPR - messages which contain EXPRin the - message header ***) + messages which contain EXPRin the + message header ***) =h STRING - If IMAP is enabled, like ~h but searches for - STRINGon the server, rather than - downloading each message and searching it locally; - STRINGmust be of the form - header: substring(see below). + If IMAP is enabled, like ~h but searches for + STRINGon the server, rather than + downloading each message and searching it locally; + STRINGmust be of the form + header: substring(see below). @@ -7420,8 +7420,8 @@ set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s" ~X [ MIN]-[ MAX] - messages with MINto - MAXattachments *) ****) + messages with MINto + MAXattachments *) ****) diff --git a/mutt_notmuch.c b/mutt_notmuch.c index 57cdd2ef7..1840613d8 100644 --- a/mutt_notmuch.c +++ b/mutt_notmuch.c @@ -1091,7 +1091,7 @@ static struct Header *get_mutt_header(struct Context *ctx, notmuch_message_t *ms } /** - * append_message - Associcate a message + * append_message - Associate a message * @param ctx Mailbox * @param q Notmuch query * @param msg Notmuch message diff --git a/pop.c b/pop.c index a454883e7..07dd0d2bc 100644 --- a/pop.c +++ b/pop.c @@ -1031,7 +1031,7 @@ fail: } /** - * mx_comp_ops - Mailbox callback functions + * mx_pop_ops - Mailbox callback functions */ struct MxOps mx_pop_ops = { .open = pop_open_mailbox, -- 2.40.0