Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The prefix to use for these include files and underlying code in e.g. InkAPI.cc is one of

  • TS or TS_
  • ts

In addition, none of these methods, struct names or definitions should be used in the core itself, other than the actual API implementations (InkAPI.cc etc.).

...

For all other code that's internal, the prefix should be one of

  • ATS or ATS_
  • ats or ats_
  • INK or INK_
  • ink or ink_

No new code / functionality should be added using the ink/INK prefix. Long term, we will migrate these into the ats/ATS prefix. Adhering to these rules is important, the goal is to be able to easily distinguish public from private APIs. In the past, we've had several cases where public APIs were used in the private code implementation, and this is a bad idea for both performance and functionality.

Header files

In most subsystems, header files are named with a P_ or I_ prefix. P_ files should contain any types and definitions that are private to the subsystem, while the public interface should be contained in a I_-prefixed header.

...