Re: [BBDB] ChangeLog 2011-11-20

2011-11-26 Thread Philip Hudson
On 26 Nov, 2011, at 8:28 am, Roland Winkler wrote:

 On Thu Nov 24 2011 Stefan Monnier wrote:
 Yet the main thing for me is: My time is limited for such things; I
 need to set up priorities. Currently I find it more important to
 have a more coherent documentation of the new code including a
 proper up-to-date info manual. (Well, in the long run, a proper
 release wouldn't be bad either)

 If anybody else wants to work on this, please go ahead. In my
 opinion, the EmacsWiki UpgradeBBDB put up by Leo is a good starting
 point

  http://www.emacswiki.org/emacs/UpgradeBBDB

 Please, contribute to it if you find anything noteworthy.

Just added a few lines three or four days ago, immediately before  
joining this list. More questions than findings.

Been meaning to learn some TeX-based ML. Infotex might be as good a  
place to start as any. Sadly I don't know BBDB at all yet. So, no  
domain knowledge, no implementation knowledge, the answer to your  
prayers. :-)

Maybe I'll start with code doco, just standards compliance and  
formatting and filling in missing docstrings where I can. That'll help  
build the domain knowledge. Patches to the list, right?

--
Phil Hudson  http://hudson-it.no-ip.biz
@UWascalWabbit PGP/GnuPG ID: 0x887DCA63


--
All the data continuously generated in your IT infrastructure 
contains a definitive record of customers, application performance, 
security threats, fraudulent activity, and more. Splunk takes this 
data and makes sense of it. IT sense. And common sense.
http://p.sf.net/sfu/splunk-novd2d
___
bbdb-info@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/bbdb-info
BBDB Home Page: http://bbdb.sourceforge.net/


Re: [BBDB] ChangeLog 2011-11-20

2011-11-26 Thread Roland Winkler
On Sat Nov 26 2011 Philip Hudson wrote:
 Maybe I'll start with code doco, just standards compliance and  
 formatting and filling in missing docstrings where I can. That'll help  
 build the domain knowledge. Patches to the list, right?

You'd like to provide documentation patches that are supposed to go
into BBDB itself? They are welcome!

You may want to take a look at the node Documentation in the elisp
manual, as well as the node Documentation Tips in the appendix.

Roland



PS: If your patches become more substantial,  I'd appreciate if
you could please assign the copyright for your work on BBDB / Emacs
to the Free Software foundation. This will help us to make BBDB free
software, see http://www.gnu.org/philosophy/philosophy.html 
For this, you should please fill out the questionaire below and send
it to fsf-reco...@gnu.org.

In the form below I inserted as program or package both Emacs and
BBDB/Emacs because we want to make BBDB part of GNU Emacs. So if
your copyright assignment covers both, this will make things easier
in the future.

Thanks a lot for your supporting BBDB / Emacs.


-

Please email the following information to fsf-reco...@gnu.org, and we
will send you the assignment form for your past and future changes.
Please use your full name as the subject line of the message.


[What is the name of the program or package you're contributing to?]

Emacs and BBDB/Emacs

[Did you copy any files or text written by someone else in these changes?
Even if that material is free software, we need to know about it.]


[Do you have an employer who might have a basis to claim to own
your changes?  Do you attend a school which might make such a claim?]


[For the copyright registration, what country are you a citizen of?]


[What year were you born?]


[Please write your email address here.]


[Please write your snail address here.]


[Which files have you changed so far, and which new files have you written
so far?]

--
All the data continuously generated in your IT infrastructure 
contains a definitive record of customers, application performance, 
security threats, fraudulent activity, and more. Splunk takes this 
data and makes sense of it. IT sense. And common sense.
http://p.sf.net/sfu/splunk-novd2d
___
bbdb-info@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/bbdb-info
BBDB Home Page: http://bbdb.sourceforge.net/


Re: [BBDB] ChangeLog 2011-11-20

2011-11-21 Thread Sam Steingold
 * Roland Winkler jvax...@tah.bet [2011-11-20 23:13:36 -0600]:

 On Sun Nov 20 2011 Sam Steingold wrote:
 as I said before, TRT is to use define-obsolete-function-alias 
 define-obsolete-variable-alias

 This would require a simple one-to-one correspondence between
 function and variable names in BBDB v2 and v3 which is NOT the case.

Only if the goal is to maintain backward compatibility,
which is _not_ the case.
The goal is to use the standard emacs functionality to automatically
warn the users when they try to use obsolete variables and functions.

-- 
Sam Steingold (http://sds.podval.org/) on Ubuntu 11.10 (oneiric) X 11.0.11004000
http://camera.org http://memri.org http://pmw.org.il http://www.memritv.org
http://dhimmi.com http://openvotingconsortium.org http://mideasttruth.com
I may be getting older, but I refuse to grow up!


--
All the data continuously generated in your IT infrastructure 
contains a definitive record of customers, application performance, 
security threats, fraudulent activity, and more. Splunk takes this 
data and makes sense of it. IT sense. And common sense.
http://p.sf.net/sfu/splunk-novd2d
___
bbdb-info@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/bbdb-info
BBDB Home Page: http://bbdb.sourceforge.net/


Re: [BBDB] ChangeLog 2011-11-20

2011-11-20 Thread Sam Steingold
 * Roland Winkler jvax...@tah.bet [2011-11-20 17:52:40 -0600]:

 The new command bbdb-undocumented-variables might help you to
 identify outdated variables. This displays a list of all
 undocumented variables in the bbdb- name space.

this is a good start!
still, this does not give me any information about the replacements for
the obsolete variables.
as I said before, TRT is to use define-obsolete-function-alias 
define-obsolete-variable-alias

 All variables in BBDB 3 now have a doc string. So if you set
 variables in your init file that are not used anymore by BBDB (so
 that they are not documented anymore either), these variables will
 be displayed by bbdb-undocumented-variables. (Unfortunately, this
 fails for outdated BBDB variables that are set via your personal
 `custom-file'. Let me know if you know a better solution for this.)

just use apropos-internal and iterate over the symbols it returns,
looking for those with 'custom properties set but no doc string.

however, this is _not_ the right approach (see above)

-- 
Sam Steingold (http://sds.podval.org/) on Ubuntu 11.10 (oneiric) X 11.0.11004000
http://honestreporting.com http://www.PetitionOnline.com/tap12009/
http://camera.org http://jihadwatch.org http://thereligionofpeace.com
You can have it good, soon or cheap.  Pick two...


--
All the data continuously generated in your IT infrastructure 
contains a definitive record of customers, application performance, 
security threats, fraudulent activity, and more. Splunk takes this 
data and makes sense of it. IT sense. And common sense.
http://p.sf.net/sfu/splunk-novd2d
___
bbdb-info@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/bbdb-info
BBDB Home Page: http://bbdb.sourceforge.net/


Re: [BBDB] ChangeLog 2011-11-20

2011-11-20 Thread Roland Winkler
On Sun Nov 20 2011 Sam Steingold wrote:
 as I said before, TRT is to use define-obsolete-function-alias 
 define-obsolete-variable-alias

This would require a simple one-to-one correspondence between
function and variable names in BBDB v2 and v3 which is NOT the case.

A simple example from the latest patch:
In BBDB v2 there was

(defcustom bbdb-dwim-net-address-allow-redundancy nil
  *Non-nil means always use full name when sending mail, even if same as net.
  :group 'bbdb
  :type '(choice (const :tag Disallow redundancy nil)
 (const :tag Return only the net 'netonly)
 (const :tag Allow redundancy t)))

See the undocumented option `netonly' meaning:
Never use the full name but only the net address
- which was not quite matching intuitive expectations for a variable
with this name / this docstring.

So now there is

(defcustom bbdb-mail-avoid-redundancy nil
  Mail address to use for BBDB records when sending mail.
If non-nil do not use full name in mail address when same as mail.
If value is mail-only never use full name.
  :group 'bbdb-sendmail
  :type '(choice (const :tag Allow redundancy nil)
 (const :tag Never use full name 'mail-only)
 (const :tag Avoid redundancy t)))

define-obsolete-variable-alias would not be too helpful here.

Nobody requires you to switch to BBDB v3. But if you want to use it,
at some point you will have to work your way through functions and
variables, which are different from the old ones (see also the
updated README file for more important examples regarding BBDB's MUA
interfaces, where concepts have changed quite significantly).

Roland

--
All the data continuously generated in your IT infrastructure 
contains a definitive record of customers, application performance, 
security threats, fraudulent activity, and more. Splunk takes this 
data and makes sense of it. IT sense. And common sense.
http://p.sf.net/sfu/splunk-novd2d
___
bbdb-info@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/bbdb-info
BBDB Home Page: http://bbdb.sourceforge.net/