Ticket #443 (closed deprecation: fixed)

Opened 5 years ago

Last modified 3 years ago

C API brought into line with coding standards

Reported by: allison Owned by: whiteknight
Priority: normal Milestone:
Component: coding_standards Version:
Severity: medium Keywords:
Cc: Language:
Patch status: Platform:

Description

There are still a number of C API functions that don't conform to the coding standards naming convention of prefixing each function name with 'Parrot_<system>_...'

All API function names that don't conform to this standard are deprecated and will be renamed (or removed) before 1.4 or 2.0.

Change History

  Changed 5 years ago by coke

Two questions; Are API functions just those marked with PARROT_API ?

It would be nice to get an explicit list of these functions in, both for the people who need to do the renames, and to have in DEPRECATED.pod (someone other than allison can generate the list based on the feedback here.)

  Changed 5 years ago by coke

(Bah. the second question morphed into a IWBNI, and I can't edit my old comment.)

  Changed 5 years ago by coke

'make splint | ack reserved' gives us an easy list of functions to rename, those that are reserved (e.g. string_from_literal)

in reply to: ↑ description   Changed 5 years ago by bacek

Replying to allison:

There are still a number of C API functions that don't conform to the coding standards naming convention of prefixing each function name with 'Parrot_<system>_...'

Is this ticket covers enum values? Like "Hash_key_type_int" have to be renamed into "HASH_KEY_TYPE_INTVAL" and so on.

  Changed 5 years ago by jkeenan

  • owner set to jkeenan
  • component changed from none to coding_standards

  Changed 5 years ago by jkeenan

  • owner changed from jkeenan to --

  Changed 5 years ago by allison

Eventually API functions will be marked with PARROT_API (for self documentation), but at the moment they're not marked.

The list of what functions should be considered part of the API is now in docs/embed.pod, under the heading "EXPORTED FUNCTIONS", so we can create a specific list of deprecations and renamings from that.

  Changed 4 years ago by coke

  • type changed from todo to deprecated
  • summary changed from [TODO] C API brought into line with coding standards to C API brought into line with coding standards

  Changed 4 years ago by coke

  • owner -- deleted

  Changed 4 years ago by cotto

This doesn't strike me as a ticket that can be easily closed, though I know some progress has been made since it was filed. Would someone care to propose a strategy for testing this, or should it just be closed and tickets opened for specific functions (or groups of functions) that don't conform to our coding standards.

  Changed 4 years ago by whiteknight

  • status changed from new to assigned
  • owner set to whiteknight

  Changed 4 years ago by whiteknight

Here's the list of files that I think need to still be updated at this point:

src/key.c
src/hll.c
src/hash.c
src/global_setup.c
src/vtable.c
src/utils.c
src/dynext.c
src/sub.c
src/exit.c

At least two of those listed are in-progress with GCI students. When GCI is over we can re-evaluate this list to see what still needs to be done. I suspect all the "easy" ones will be completed, at least.

  Changed 3 years ago by whiteknight

  • status changed from assigned to closed
  • resolution set to fixed

Most instances have been fixed, and this ticket is too open-ended to really be of much use. I'm closing it now.

Note: See TracTickets for help on using tickets.