2003-12-23 Moritz Schulte <mo@g10code.com>
[gpgme.git] / doc / ChangeLog
1 2003-12-23  Moritz Schulte  <mo@g10code.com>
2
3         * gpgme.texi (Listing Keys): Minor clarification for
4         gpgme_get_key.
5
6 2003-10-06  Marcus Brinkmann  <marcus@g10code.de>
7
8         * gpgme.texi (Signal Handling): New section.
9
10 2003-09-14  Marcus Brinkmann  <marcus@g10code.de>
11
12         * gpgme.texi (Multi Threading): Correct documentation on memory
13         synchronization requirement.
14
15         * gpgme.texi (Locale): New section.
16         (Multi Threading): Set locale in example.
17
18 2003-09-13  Marcus Brinkmann  <marcus@g10code.de>
19
20         * gpgme.texi (Error Strings): Add gpgme_strerror_r.
21
22 2003-09-13  Marcus Brinkmann  <marcus@g10code.de>
23
24         * gpgme.texi (Multi Threading): Update documentation.
25
26 2003-09-03  Marcus Brinkmann  <marcus@g10code.de>
27
28         * gpgme.texi (Header): We don't use the assuan namespace anymore.
29         Document new thread options.
30
31 2003-08-14  Marcus Brinkmann  <marcus@g10code.de>
32
33         * gpgme.texi (Creating a Signature): Change type of member class
34         to unsigned int.
35
36 2003-08-04  Marcus Brinkmann  <marcus@g10code.de>
37
38         * gpgme.texi (Verify): Get error code from SIG->status in the code
39         for gpgme_get_sig_status.
40
41 2003-07-31  Marcus Brinkmann  <marcus@g10code.de>
42
43         * gpgme.texi (Key Management): Add can_authenticate flag.
44
45         * gpgme.texi (Listing Keys): Document GPG_ERR_AMBIGUOUS_NAME for
46         gpgme_get_key.
47
48 2003-07-29  Marcus Brinkmann  <marcus@g10code.de>
49
50         * Makefile.am (EXTRA_DIST): Remove variable.
51
52         * gpgme.texi (Encrypting a Plaintext): Bad passphrase is only
53         possible with symmetric encryption, change the wording to reflect
54         that.
55
56         * gpgme.texi (Creating a Signature): Document
57         GPG_ERR_UNUSABLE_SECKEY.
58
59         * gpgme.texi (Encrypting a Plaintext): Mention encrypt and sign
60         operations in result function.
61         (Creating a Signature): Likewise.
62
63 2003-07-23  Marcus Brinkmann  <marcus@g10code.de>
64
65         * gpgme.texi (Key Listing Mode): Remove word duplication.
66         (Listing Keys): Remove mentioning of force argument.
67         (Verify): Don't mention r_stat.  Fix some typos.
68         (Decrypt and Verify): Correct info how to get the result.  Don't
69         mention r_stat.
70         (Manipulating Data Buffers): Fix documentation of return value.
71         (Listing Keys): Update examples.
72         (Decrypt): Result might also be available when operation failed.
73         (Verify): Result might also be available when operation failed.
74         All spotted by St├ęphane Corth├ęsy.
75
76 2003-07-22  Marcus Brinkmann  <marcus@g10code.de>
77
78         * gpgme.texi (Error Sources): Fix cut and paste error.
79
80 2003-07-09  Marcus Brinkmann  <marcus@g10code.de>
81
82         * gpgme.texi (Key Management): Clarify difference between can_sign
83         and can_certify.
84         (Information About Keys): Likewise for GPGME_ATTR_CAN_SIGN and
85         GPGME_ATTR_CAN_CERTIFY.
86
87 2003-07-08  Marcus Brinkmann  <marcus@g10code.de>
88
89         * gpgme.texi (Progress Meter Callback): Change return type of
90         gpgme_progress_cb_t to void.
91
92 2003-06-22  Marcus Brinkmann  <marcus@g10code.de>
93
94         * gpgme.texi: Add 2003 to copyright notice.
95
96         * gpgme.texi (Header): Fix name space documentation on
97         libgpg-error.
98
99 2003-06-22  Marcus Brinkmann  <marcus@g10code.de>
100
101         * gpgme.texi (Multi Threading): Remove reference to
102         gpgme_recipients_t.
103
104 2003-06-06  Marcus Brinkmann  <marcus@g10code.de>
105
106         * gpgme.texi (Crypto Operations): Rename gpgme_invalid_user_id_t
107         to gpgme_invalid_key_t.
108
109 2003-06-06  Marcus Brinkmann  <marcus@g10code.de>
110
111         * gpgme.texi: Change error codes to GPG_ERR_* variants.
112         (Error Handling): Rewritten.
113
114 2003-05-29  Marcus Brinkmann  <marcus@g10code.de>
115
116         * gpgme.texi (Exporting Keys): Change and document prototypes.
117         Add new gpgme_op_export_ext and gpgme_op_export_ext_start
118         variants.
119         (Selecting Recipients): Section removed.
120         (Encrypting a Plaintext): Change prototypes and document the
121         changes.
122
123 2003-05-28  Marcus Brinkmann  <marcus@g10code.de>
124
125         * gpgme.texi (Exporting Keys): Change argument type from
126         gpgme_recipient_t to gpgme_user_id_t.
127         (Encrypting a Plaintext): Likewise.
128         (Selecting Recipients): Rewritten.
129
130 2003-05-27  Marcus Brinkmann  <marcus@g10code.de>
131
132         * gpgme.texi (Protocol Selection): Do not use @acronym in @node
133         because that breaks texi2dvi.
134
135         * gpgme.texi (Passphrase Callback): Document new prototype.
136
137 2003-05-18  Marcus Brinkmann  <marcus@g10code.de>
138
139         * gpgme.texi (Header): Remove Gpgme as namespace prefix.  Add
140         _GPGME to namespace prefix.
141         * gpgme.texi (Multi Threading): Add note about link order.
142
143 2003-05-04  Marcus Brinkmann  <marcus@g10code.de>
144
145         * gpgme.texi (Listing Keys): Document what happens if key is not
146         found.
147
148         * gpgme.texi (Importing Keys): Fix cut and paste error.
149
150 2003-04-30  Marcus Brinkmann  <marcus@g10code.de>
151
152         * gpgme.texi (Encrypting a Plaintext): Remove reference to
153         gpgme_get_op_info.
154         (Detailed Results): Subsection removed.
155
156         * gpgme.texi (Key Listing Mode): Add GPGME_KEYLIST_MODE_SIGS.
157         (Manipulating Keys): Add obsoleteness note.
158         (Key Signatures): Likewise.
159         (Information About Keys): Likewise.
160         (Key Management): Add new data types GpgmeSubkey, GpgmeKeySig,
161         GpgmeUserID, and all the information about GpgmeKey.
162
163 2003-04-29  Marcus Brinkmann  <marcus@g10code.de>
164
165         * gpgme.texi (Listing Keys): Remove force_update argument from
166         gpgme_get_key.
167
168         * gpgme.texi (Trust Item Management): Add data members of
169         GpgmeTrustItem type.
170         (Information About Trust Items): Add note about obsoleteness.
171         (Manipulating Trust Items): Add gpgme_trust_item_ref and
172         gpgme_trust_item_unref.
173
174 2003-04-28  Marcus Brinkmann  <marcus@g10code.de>
175
176         * gpgme.texi (Verify): Rewritten to take into account new and
177         deprecated functions and data types.
178
179         * gpgme.texi (Decrypt): Descript gpgme_op_decrypt_result and
180         GpgmeDecryptResult.
181
182 2003-04-27  Marcus Brinkmann  <marcus@g10code.de>
183
184         * gpgme.texi (Encrypting a Plaintext): Add info about
185         GpgmeEncryptResult and gpgme_op_encrypt_result.
186
187         * gpgme.texi (Creating a Signature): Add info about
188         GpgmeNewSignature, GpgmeSignResult and gpgme_op_sign_result.
189         (Crypto Operations): Add GpgmeInvalidUserID.
190         (Algorithms): New chapter.
191
192         * gpgme.texi (Deleting Keys): Document
193         GPGME_Ambiguous_Specification.
194         (Error Values): Remove GPGME_Invalid_Type and GPGME_Invalid_Mode.
195         Add GPGME_Unknown_Reason, GPGME_Not_Found,
196         GPGME_Ambiguous_Specification, GPGME_Wrong_Key_Usage,
197         GPGME_Key_Revoked, GPGME_Key_Expired, GPGME_No_CRL_Known,
198         GPGME_CRL_Too_Old, GPGME_Policy_Mismatch, GPGME_No_Secret_Key,
199         GPGME_Key_Not_Trusted, GPGME_Issuer_Missing, GPGME_Chain_Too_Long,
200         GPGME_Unsupported_Algorithm, GPGME_Sig_Expired,
201         GPGME_Bad_Signature, GPGME_No_Public_Key.
202
203 2003-04-25  Marcus Brinkmann  <marcus@g10code.de>
204
205         * gpgme.texi (Importing Keys): Change GPGME_IMPORT_PRIVATE to
206         GPGME_IMPORT_SECRET.
207
208         * gpgme.texi (Importing Keys): Remove note about gpgme_get_op_info.
209         (Detailed Results): Remove note about import.
210
211         * gpgme.texi (Importing Keys): Add documentation for
212         GpgmeImportStatus, GpgmeImportResult and gpgme_op_import_result.
213
214         * gpgme.texi (Generating Keys): Fix documentation of public and
215         secret arguments.
216
217 2003-04-24  Marcus Brinkmann  <marcus@g10code.de>
218
219         * gpgme.texi (Generating Keys): Document changed gpgme_op_genkey
220         and new gpgme_op_genkey_result function.  Document
221         GpgmeGenKeyResult data type.
222
223         * gpgme.texi (Error Values): Rename GPGME_No_Passphrase to
224         GPGME_Bad_Passphrase.
225         * gpgme.texi (Decrypt): Likewise.
226         (Decrypt and Verify): Likewise.
227         (Creating a Signature): Likewise.
228         (Encrypting a Plaintext): Likewise.
229
230         * gpgme.texi (Error Values): Rename GPGME_No_Recipients to
231         GPGME_No_UserID and GPGME_Invalid_Recipient to
232         GPGME_Invalid_UserID.
233         (Encrypting a Plaintext): Likewise.
234
235         * gpgme.texi (Error Values): Remove GPGME_Busy and GPGME_No_Request.
236         (Listing Keys): Likewise.
237         (Listing Trust Items): Likewise.
238
239 2003-02-06  Marcus Brinkmann  <marcus@g10code.de>
240
241         * gpgme.texi (Cancelling an Operation): Removed.
242         (Passphrase Callback): Document new type for GpgmePassphraseCb.
243
244 2003-01-30  Marcus Brinkmann  <marcus@g10code.de>
245
246         * gpgme.texi (Engine Information): Rename member part to
247         file_name.
248
249         * gpgme.texi (Protocols and Engines): Document
250         gpgme_get_protocol_name.
251
252         * gpgme.texi (Engine Information): Rewritten.
253
254 2003-01-29  Marcus Brinkmann  <marcus@g10code.de>
255
256         * gpgme.texi (I/O Callback Interface): Document new even
257         GPGME_EVENT_START.
258         (Waiting For Completion): Document new possible return values.
259         (I/O Callback Interface): Document return type of GpgmeIOCb.
260
261 2003-01-29  Marcus Brinkmann  <marcus@g10code.de>
262
263         * gpgme.texi (Hooking Up Into Idle Time): Section removed.
264
265 2002-12-24  Marcus Brinkmann  <marcus@g10code.de>
266
267         * gpgme.texi (Verify): Drop R_STAT argument in gpgme_op_verify.
268         * gpgme.texi (Decrypt and Verify): Likewise for
269         gpgme_op_decrypt_verify.
270
271 2002-12-23  Marcus Brinkmann  <marcus@g10code.de>
272
273         * gpgme.texi (Information About Keys): Document that
274         GPGME_ATTR_IS_SECRET is not representable as a string anymore.
275
276 2002-12-22  Marcus Brinkmann  <marcus@g10code.de>
277
278         * gpgme.texi (Key Signatures): New section.
279         (Listing Keys): Add gpgme_get_key.
280
281 2002-12-06  Marcus Brinkmann  <marcus@g10code.de>
282
283         * gpgme.texi (Memory Based Data Buffers): New subsection.
284         (File Based Data Buffers): Likewise.
285         (Callback Based Data Buffers): Likewise.
286         (Manipulating Data Buffers): Update interfaces.  Add
287         gpgme_data_seek.
288         * gpgme.texi (Engine Version Check): Remove gpgme_check_engine.
289         
290 2002-11-21  Marcus Brinkmann  <marcus@g10code.de>
291
292         * gpgme.texi (Verify): Document the new interface.
293
294 2002-11-19  Marcus Brinkmann  <marcus@g10code.de>
295
296         * gpgme.texi (Generating Keys): Document new argument to
297         gpgme_op_genkey.
298
299 2002-11-05  Marcus Brinkmann  <marcus@g10code.de>
300
301         * gpgme.texi (Verify): Fix prototype of gpgme_get_sig_key.
302         Reported by Miguel Coca <e970095@zipi.fi.upm.es>.
303
304 2002-08-30  Marcus Brinkmann  <marcus@g10code.de>
305
306         * gpgme.texi (Selecting Signers): Fix reference count.
307
308 2002-08-21  Marcus Brinkmann  <marcus@g10code.de>
309
310         * gpgme.texi (Header): Document name space.
311
312 2002-08-20  Marcus Brinkmann  <marcus@g10code.de>
313
314         * gpgme.texi (Importing Keys): Document gpgme_op_import_ext.
315
316         * gpgme.texi (Importing Keys): Undocument EOF.
317
318 2002-08-14  Werner Koch  <wk@gnupg.org>
319
320         * gpgme.texi (Information About Keys): Changed GPGME_ATTR_TYPE.
321
322 2002-07-25  Marcus Brinkmann  <marcus@g10code.de>
323
324         * gpgme.texi (Deleting Keys): Say that secret keys might not be
325         deleted.
326
327 2002-07-25  Marcus Brinkmann  <marcus@g10code.de>
328
329         * gpgme.texi (Information About Keys): Document (badly) the new
330         key attributes.
331
332         * gpgme.texi (Manipulating Data Buffers): Mention that backend
333         tries to detect encoding automatically.
334
335 2002-07-03  Marcus Brinkmann  <marcus@g10code.de>
336
337         * gpgme.texi (Run Control): Update this section.
338         (Waiting For Completion): Likewise for this subsection.
339         (Cancelling an Operation): Likewise for this subsection.
340         (Using External Event Loops): New subsection with several
341         subsubsections.
342
343 2002-06-28  Marcus Brinkmann  <marcus@g10code.de>
344
345         * gpgme.texi (Multi Threading): Remove item about the need to
346         synchronize anything against gpgme_wait (except gpgme_wait
347         itself).
348
349 2002-06-27  Marcus Brinkmann  <marcus@g10code.de>
350
351         * gpgme.texi (Information About Keys): Fix documentation for IDX.
352         (Information About Trust Items): Likewise.
353
354 2002-06-26  Werner Koch  <wk@gnupg.org>
355
356         * gpgme.texi (Importing Keys): Document the return value -1 of
357         gpgme_op_import.
358
359 2002-06-20  Werner Koch  <wk@gnupg.org>
360
361         * gpgme.texi (Verify): Explain the new whatidx variable.
362
363 2002-06-10  Werner Koch  <wk@gnupg.org>
364
365         * gpgme.texi (Verify): Document attribute GPGME_ATTR_ERRTOK.
366
367 2002-06-04  Marcus Brinkmann  <marcus@g10code.de>
368
369         * gpgme.texi (Multi Threading): Document new autodetection.
370
371 2002-06-04  Marcus Brinkmann  <marcus@g10code.de>
372
373         * Makefile.am (DISTCLEANFILES): New variable.
374
375 2002-05-26  Marcus Brinkmann  <marcus@g10code.de>
376
377         * gpgme.texi: Some typographical correctons throughout.
378
379 2002-05-09  Marcus Brinkmann  <marcus@g10code.de>
380
381         * gpgme.texi (Using Automake): New section.
382
383 2002-05-09  Marcus Brinkmann  <marcus@g10code.de>
384
385         * gpgme.texi (Multi Threading): Escape { and }.
386
387 2002-05-09  Marcus Brinkmann  <marcus@g10code.de>
388
389         * gpgme.texi (Overview): Replace note about thread-safeness.
390         (Multi Threading): New section.
391
392 2002-05-03  Werner Koch  <wk@gnupg.org>
393
394         * gpgme.texi (Manipulating Data Buffers): Changed some data types
395         to void*.
396         (Protocol Selection): Added gpgme_get_protocol.
397         (Verify): Updated to include the new attribute fucntions and
398         status codes.
399
400 2002-04-27  Werner Koch  <wk@gnupg.org>
401
402         * gpgme.texi (Manipulating Data Buffers): New type GpgmeDataEncoding.
403
404 2002-04-23  Marcus Brinkmann  <marcus@g10code.de>
405
406         * gpgme.texi (Passphrase Callback): Document that either return
407         argument can be NULL.
408         (Progress Meter Callback): Likewise.
409
410 2002-04-22  Marcus Brinkmann  <marcus@g10code.de>
411
412         * gpgme.texi (Passphrase Callback): Fix small typo.  Document the
413         new function gpgme_get_passphrase_cb.
414         (Progress Meter Callback): Document the new function
415         gpgme_get_progress_cb.
416
417 2002-04-16  Marcus Brinkmann  <marcus@g10code.de>
418
419         * gpgme.texi (Creating a Signature): Fix function name.  Reported
420         by Wichert Ackerman <wichert@debian.org>.
421
422 2002-03-29  Marcus Brinkmann  <marcus@g10code.de>
423
424         * gpgme.texi (direntry): End index entry with a full stop.
425         Patch submitted by Jose Carlos Garcia Sogo <jsogo@debian.org>.
426         
427 2002-03-17  Marcus Brinkmann  <marcus@g10code.de>
428
429         * gpgme.texi (Detailed Results): Fix syntax error in last change.
430
431 2002-03-08  Werner Koch  <wk@gnupg.org>
432
433         * gpgme.texi (Detailed Results): Import does also return info.
434
435 2002-03-06  Marcus Brinkmann  <marcus@g10code.de>
436
437         * gpgme.texi (Encrypting a Plaintext): Document symmetric
438         encryption.
439
440 2002-03-06  Marcus Brinkmann  <marcus@g10code.de>
441
442         * gpgme.texi (Error Strings): Add example.
443         * gpgme.texi (Listing Keys): Likewise.
444
445 2002-03-03  Marcus Brinkmann  <marcus@g10code.de>
446
447         * gpgme.texi (Information About Keys): Document GPGME_ATTR_EXPIRE.
448
449 2002-03-03  Marcus Brinkmann  <marcus@g10code.de>
450
451         * gpgme.texi (Verify): Document verification of normal and
452         cleartext signatures.
453
454 2002-02-27  Marcus Brinkmann  <marcus@g10code.de>
455
456         * gpgme.texi (Listing Keys): Document gpgme_op_keylist_ext_start.
457
458 2002-02-27  Marcus Brinkmann  <marcus@g10code.de>
459
460         * gpgme.texi (Encrypting a Plaintext): Document
461         GPGME_Invalid_Recipients.
462         (Error Values): Likewise.
463
464 2002-02-26  Marcus Brinkmann  <marcus@g10code.de>
465
466         * gpgme.texi (Encrypting a Plaintext): Document
467         gpgme_op_encrypt_sign and gpgme_op_encrypt_sign_start.
468
469 2002-02-25  Marcus Brinkmann  <marcus@g10code.de>
470
471         * gpgme.texi (Creating a Signature): Add a note about
472         certificates to include.
473         (Included Certificates): New section.
474
475 2002-02-09  Marcus Brinkmann  <marcus@g10code.de>
476
477         * gpgme.texi (Detailed Results): Remove literal tags.
478         (Generating Keys): Update documentation.
479
480         * gpgme.texi (Generating Keys): Fix syntax error.
481
482 2002-02-06  Marcus Brinkmann  <marcus@g10code.de>
483
484         * gpgme.texi (Waiting For Completion): Adjust doc to changes in
485         the code.
486
487 2002-02-06  Marcus Brinkmann  <marcus@g10code.de>
488
489         * gpgme.texi (Key Listing Mode): Update documentation.
490
491 2002-01-31  Marcus Brinkmann  <marcus@g10code.de>
492
493         * gpgme.texi (Generating Keys): Document error at creation
494         failure.
495
496 2002-01-30  Marcus Brinkmann  <marcus@g10code.de>
497
498         * gpgme.texi (Deleting Keys): Document new error values.
499
500 2002-01-30  Marcus Brinkmann  <marcus@g10code.de>
501
502         * gpgme.texi (Importing Keys): Add reference to gpgme_get_op_info.
503
504 2002-01-30  Marcus Brinkmann  <marcus@g10code.de>
505
506         * gpgme.texi: Some spell checking.
507
508 2002-01-30  Marcus Brinkmann  <marcus@g10code.de>
509
510         * gpgme.texi: Add all the gpgme_op_*_start functions.
511         Fill the concept index with many, many entries.
512
513 2002-01-29  Marcus Brinkmann  <marcus@g10code.de>
514
515         * gpgme.texi (Run Control): New section.
516         (Verify): Docuent gpgme_get_notation.
517         (More Information): New section describing gpgme_get_op_info.
518
519 2002-01-22  Marcus Brinkmann  <marcus@g10code.de>
520
521         * gpgme.texi (Passphrase callback): Change GpgmePassphraseCb's
522         R_HD type from void* to void**.
523
524 2002-01-22  Marcus Brinkmann  <marcus@g10code.de>
525
526         * gpgme.texi (Creating data buffers): Change
527         gpgme_data_new_from_filepart's LENGTH type from off_t to size_t.
528
529 2002-01-22  Marcus Brinkmann  <marcus@g10code.de>
530
531         * gpgme.texi (Generating keys): New subsection.
532         (Exporting keys): Likewise.
533         (Importing keys): Likewise.
534         (Deleting keys): Likewise.
535
536 2002-01-16  Marcus Brinkmann  <marcus@g10code.de>
537
538         * gpgme.texi: g10Code -> g10 Code
539
540         * gpgme.texi (Top): Complete detailmenu.
541         
542         * gpgme.texi: Convert embarassing cruft to the real thing.
543
544 2002-01-16  Marcus Brinkmann  <marcus@g10code.de>
545
546         * ChangeLog: New file.
547         * gpgme.texi: Likewise.
548         * gpl.texi: Likewise.
549         * fdl.texi: Likewise.
550         * Makefile.am (info_TEXINFOS): New variable.
551         (gpgme_TEXINFOS): Likewise.
552
553  Copyright 2002 g10 Code GmbH
554
555  This file is free software; as a special exception the author gives
556  unlimited permission to copy and/or distribute it, with or without
557  modifications, as long as this notice is preserved.
558
559  This file is distributed in the hope that it will be useful, but
560  WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
561  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.