Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Add more useful information to Glossary.md #31879

Closed
wants to merge 6 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
83 changes: 73 additions & 10 deletions glossary.md
@@ -1,16 +1,79 @@
You may also need to check https://chromium.googlesource.com/chromiumos/docs/+/master/glossary.md.

* LGTM: "Looks good to me", commonly used to approve a code review.
* PTAL: Please take a look.
* RSLGTM: "Rubber-stamp looks good to me". The reviewer approving without doing
* ABI: [Application Binary Interface](https://en.wikipedia.org/wiki/Application_binary_interface)
* ASAP: As Soon As Possible.
* BE: Big Endian - Byte order style in a multibyte data.
(Opposite of LE, Little Endian)
* CI: [Continuous Integration](https://en.wikipedia.org/wiki/Continuous_integration).
* CITGM: Canary In The Gold Mine - a smoke test unit in the repo that
contain popular npm modules.
* CJS: Common JS.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* CJS: Common JS.
* CJS: CommonJS. In most cases, [CommonJS Modules](https://nodejs.org/api/modules.html#modules-commonjs-modules).

* CLDR: [Common Locale Data Repository](https://en.wikipedia.org/wiki/Common_Locale_Data_Repository).
* CLI: [Command Line Interface](https://en.wikipedia.org/wiki/Command-line_interface).
* CVE: Common Vulnerebilities and Exposures - A database that
Copy link
Member

Choose a reason for hiding this comment

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

(Typo) CVE: Common Vulnerabilities and Exposures

maintains reported security exposures.
* ECMA: European Computer Manufacturers Association - A body that
governs JS spec among other things.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
governs JS spec among other things.
governs the specification of the JavaScript language, among other things.

* EOF: [End Of File](https://en.wikipedia.org/wiki/End-of-file)
* EOL: End Of Line (when used within a program), End of Life
(when used within project documents).
* ESM: ECMA Script Module.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* ESM: ECMA Script Module.
* ESM: [ECMAScript Module](https://nodejs.org/api/esm.html#modules-ecmascript-modules)

* ETW: Event Tracing for Windows.
* FFDC: First Failure Data Capture - Common terms for logs, traces
and dumps that are produced by default on program error.
* FIPS: Federal Information Processing Standards.
Copy link
Member

Choose a reason for hiding this comment

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

Double spacing is not needed

* FS: File System.
* ICU: International Components for Unicode.
* IPC: Inter Process Communication.
* JIT: [Just In Time](https://en.wikipedia.org/wiki/Just-in-time_compilation)
Is a way of executing computer code that involves compilation during execution
of a program `at run time` rather than before execution.
* JS/C++ boundary: It refers to the boundary between V8's runtime and the
JS code execution which are commonly crossed when invoking JS functions with
C++ linkage (e.g. interceptors). The boundary could very well exist when we
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
C++ linkage (e.g. interceptors). The boundary could very well exist when we
C++ linkage (e.g. `v8::FunctionCallback`). The boundary exist when we

interceptors are only very rarely used. v8::FunctionCallbacks are a lot more common.

are reaching into the C++ to do something that has nothing to do with the
platform, e.g. URL parsing.
* LGTM: Looks good to me - commonly used to approve a code review.
* LTS: Long Term Support.
* MDN: [Mozila Development Network](https://developer.mozilla.org/en-US).
* OOB: Out Of Bounds - Used in the context of array(memory) access.
* OOM: Out Of Memory.
* PPC: Power PC.
* PTAL: Please Take A Look.
* RAII: [Resource Aquisition Is Intialization](https://en.wikipedia.org/wiki/Resource_acquisition_is_initialization)
* REPL: Read Evaluate Print Loop. REPL is available as a standalone program
(invoke node without arguments), used for developing / testing small programs.
* RFC: Request For Comments.
* RSLGTM: Rubber-Stamp Looks Good To Me. The reviewer approving without doing
a full code review.
* RSS: [Resident Set Size](https://en.wikipedia.org/wiki/Resident_set_size).
* SMP: Symmetric Multi Processor.
Copy link
Member

Choose a reason for hiding this comment

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

Where is this used? I don't recall seeing anyone talking about this in Node.js.

Copy link
Member Author

Choose a reason for hiding this comment

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

It's not used. Removed it.

* TSC: Technical Steering Committee. Detailed info see
[TSC](./GOVERNANCE.md#technical-steering-committee).
* WIP: "Work In Progress" - e.g. a patch that's not finished, but may be worth
an early look.
* V8: JavaScript engine that powers Node.js and chrome browser.
* VM: The [VM module](https://nodejs.org/api/vm.html) provides a way of
executing JavaScript on a virtual machine.
* WASI: [Web Assemby System Interface]( https://github.com/WebAssembly/WASI)
* WASM: Web Assembly.
* WG: Working Group - autonomous teams in the project with specific
focus areas.
* WHATWG: Web Hypertext Application Technology Working Group
* WIP: "Work In Progress" - e.g. a patch that's not finished, but
may be worth an early look.
* WPT: [web-platform-tests](https://github.com/web-platform-tests/wpt)
* godbolt: [Compiler Explorer](https://godbolt.org/) run compilers interactively
from your web browser and interact with the assembly. Was created by and is
primarily administrated by Matt Godbolt.
* primordials: Pristine built-ins that are not effected by prototype pollution
and tampering with built-ins.
* bootstrap: Early phase in the Node.js process startup - that sets up
the Node.js execution environment and loads the internal modules.
* code cache: A chunk of bytes storing compiled JS code and its metadata.
* deps: upstream projects that this project depends.
* godbolt: [Compiler Explorer](https://godbolt.org/) run compilers
interactively from your web browser and interact with the assembly.
Was created by and is primarily administrated by Matt Godbolt.
* native modules/addons: A module / shared library that is
implemented in C/C++, but exposes one or more interfaces,
callable from JS.
* primordials: Pristine built-ins that are not effected by prototype
pollution and tampering with built-ins.
* snapshot: When referring to the V8 startup snapshot, a chunk of
bytes containing data serialized from a V8 heap, which can be
deserialized to restore the states of the V8 engine.
* vendoring: consuming external software into this project.