Skip to content

Development guide: private and public API section - #303

Open
arut wants to merge 1 commit into
nginx:mainfrom
arut:public-private-api
Open

Development guide: private and public API section#303
arut wants to merge 1 commit into
nginx:mainfrom
arut:public-private-api

Conversation

@arut

@arut arut commented Aug 6, 2026

Copy link
Copy Markdown
Collaborator

No description provided.

@arut arut self-assigned this Aug 6, 2026
Comment thread xml/en/docs/dev/development_guide.xml Outdated
Comment thread xml/en/docs/dev/development_guide.xml Outdated
Comment thread xml/en/docs/dev/development_guide.xml Outdated
</para>

<para>
Accessing nginx data that is defined in C source files and not exported

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"data" may need clarification

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like what?


<para>
Accessing nginx data that is defined in C source files and not exported
through header files is strongly discouraged, as is copying standard nginx

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/as is/as well as/ ?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I consulted AI for this.

Accessing nginx data that is defined in C source files and not exported
through header files is strongly discouraged, as is copying standard nginx
functions in order to alter their behavior.
Such code is fragile: it may become binary incompatible with a later nginx

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Such approach ?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, AI helped me to phrase this correctly. Using "approach" invalidates the later part of the sentence.

Accessing nginx data that is defined in C source files and not exported
through header files is strongly discouraged, as is copying standard nginx
functions in order to alter their behavior.
Such code is fragile: it may become binary incompatible with a later nginx

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion:
the resulting binary may become incompatible when compiling against later nginx versions

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like a complication.

Comment thread xml/en/docs/dev/development_guide.xml
@arut
arut force-pushed the public-private-api branch 2 times, most recently from 765531a to a799b8c Compare August 7, 2026 15:08
@arut
arut force-pushed the public-private-api branch from a799b8c to 3ec3824 Compare August 7, 2026 15:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants