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