1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-04-22 05:51:11 -07:00

Explaining why commented-out events exist in the list.

Copied from Perforce
 Change: 179204
 ServerID: perforce.ravenbrook.com
This commit is contained in:
Richard Brooksby 2012-09-03 15:32:22 +01:00
parent 1772fa46cc
commit 3a8367dc4d

View file

@ -47,6 +47,11 @@
* - Kind: Category into which this event falls, without the
* leading "EventKind";
*
* When you retire an event type, don't delete it from the list -- comment
* it out. This serves as documentation for what the event code means
* in older logs, and prevents the codes being re-used. See
* <design/telemetry/#.reg.code>.
*
* TODO: Add a doc string to each event type.
*
* See also EVENT_*_PARAMS for definition of event parameters.
@ -55,8 +60,6 @@
#define EventNameMAX ((size_t)19)
#define EventCodeMAX ((EventCode)0x0071)
/* TODO: Work out why not-in-use events were not in use and restore or delete them. */
#define EVENT_LIST(EVENT, X) \
/* 0123456789012345678 <- don't exceed without changing EventNameMAX */ \
EVENT(X, AMCGenCreate , 0x0001, TRUE, Pool) \