Opened 7 months ago

Last modified 3 months ago

#30349 new task

Document member-hiding conventions for structs

Reported by: catalyst Owned by:
Priority: Medium Milestone: Tor: unspecified
Component: Core Tor/Tor Version:
Severity: Normal Keywords: technical-debt, refactoring, network-team-roadmap-october, s31-docs
Cc: nickm Actual Points:
Parent ID: #29209 Points: 1
Reviewer: Sponsor: Sponsor31-can

Description

We should document whatever conventions we choose for hiding struct members, probably in doc/HACKING. Also we should make tools for searching for violations, e.g., code that directly accesses private members without using the appropriate macros. (A fairly simple Coccinelle script should work for this.)

Child Tickets

Change History (6)

comment:1 Changed 7 months ago by dgoulet

Milestone: Tor: unspecified

comment:2 Changed 5 months ago by gaba

Keywords: network-team-roadmap-october added
Points: 0.51

comment:3 Changed 5 months ago by gaba

Cc: nickm added

comment:4 Changed 4 months ago by gaba

Sponsor: Sponsor31-canSponsor31-must

comment:5 Changed 3 months ago by nickm

Keywords: s31-docs added

comment:6 Changed 3 months ago by nickm

Sponsor: Sponsor31-mustSponsor31-can
Note: See TracTickets for help on using tickets.