From: Eli Zaretskii <eliz@gnu.org>
To: Thomas Fitzsimmons <fitzsim@fitzsim.org>
Cc: 16322@debbugs.gnu.org
Subject: bug#16322: Acknowledgement (24.3; [PATCH] Streamline EUDC LDAP configuration)
Date: Thu, 13 Nov 2014 22:16:07 +0200 [thread overview]
Message-ID: <83ioiikgag.fsf@gnu.org> (raw)
In-Reply-To: <m3zjbvqb34.fsf@fitzsim.org>
> From: Thomas Fitzsimmons <fitzsim@fitzsim.org>
> Cc: 16322@debbugs.gnu.org
> Date: Thu, 13 Nov 2014 12:11:59 -0500
>
> * eudc.texi (LDAP Configuration): Rename from LDAP Requirements
> and provide configuration examples.
A few comments about this part:
> +LDAP support is added by means of @file{ldap.el}, which is part of
> +Emacs. @file{ldap.el} needs an external command line utility named
> +@file{ldapsearch}, available as part of OpenLDAP
Command names are better given the @command markup (here and elsewhere
in the patch).
> +@subsection Emacs-only Configuration
Please don't use sectioning commands without a corresponding @node.
Having subsections that aren't nodes makes those subsections harder to
find.
> +Specifying the function @code{ldap-password-read} for @code{passwd}
> +will cause Emacs to prompt interactively for the password. The
> +password will then be validated and cached, unless
> +@code{password-cache} is nil. You can customize
> +@code{password-cache-expiry} to control the duration for which the
> +password is cached. If you want to clear the cache, call
> +@code{password-reset}.
Each variable or function you describe should have a corresponding
@findex or @vindex entry right before the description.
> +To authenticate, the @dfn{bind distinguished name (binddn)} is
When you introduce a new term using @dfn, please provide a @cindex
entry for that term.
> +@example
> +machine ldaps://directory.example.com binddn example\emacsuser password s3cr3t
> +@end example
This line is too long, and since lines in @example are never broken by
the typesetter, it will overflow the right margin. Break it into 2 or
more lines, and indicate in the text that this is one long line, to
avoid confusion.
> +@example
> +binddn example\emacsuser password s3cr3t
> +@end example
> +
> +and the @file{.emacs} expressions become:
You need @noindent before the last line, otherwise it will be
indented, as it starts a new paragraph.
> +@lisp
> +(eval-after-load "message"
> + '(define-key message-mode-map (kbd "TAB") 'eudc-expand-inline))
> +(customize-set-variable 'eudc-server-hotlist '(("" . bbdb) ("" . ldap)))
> +(customize-set-variable 'ldap-host-parameters-alist '(("" auth-source t)))
> +@end lisp
I think these lines are also too long, consider breaking them.
Thanks.
next prev parent reply other threads:[~2014-11-13 20:16 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-01-02 1:51 bug#16322: 24.3; [PATCH] Streamline EUDC LDAP configuration Thomas Fitzsimmons
[not found] ` <handler.16322.B.138862750228330.ack@debbugs.gnu.org>
2014-11-13 8:50 ` bug#16322: Acknowledgement (24.3; [PATCH] Streamline EUDC LDAP configuration) Thomas Fitzsimmons
2014-11-13 14:49 ` Eli Zaretskii
2014-11-13 17:11 ` Thomas Fitzsimmons
2014-11-13 20:16 ` Eli Zaretskii [this message]
2014-11-15 19:58 ` Thomas Fitzsimmons
2014-12-20 21:55 ` bug#16322: 24.4; [PATCH] Streamline EUDC LDAP configuration (was: bug#16322: Acknowledgement (24.3; [PATCH] Streamline EUDC LDAP configuration)) Thomas Fitzsimmons
2015-01-20 1:44 ` bug#16322: 24.4; [PATCH] Streamline EUDC LDAP configuration Thomas Fitzsimmons
2015-01-20 16:35 ` Stefan Monnier
2015-01-20 16:40 ` Dmitry Gutov
2015-01-20 17:31 ` Stefan Monnier
2015-01-20 18:34 ` Dmitry Gutov
2015-01-23 22:22 ` bug#16322: Acknowledgement (24.3; [PATCH] Streamline EUDC LDAP configuration) Stefan Monnier
2015-01-24 6:13 ` Thomas Fitzsimmons
2015-01-25 15:07 ` Stefan Monnier
2015-01-25 23:36 ` Thomas Fitzsimmons
2015-01-28 11:25 ` Thomas Fitzsimmons
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83ioiikgag.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=16322@debbugs.gnu.org \
--cc=fitzsim@fitzsim.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).