From 2f6861ca5184797debba65c30c04fabc5ec50279 Mon Sep 17 00:00:00 2001 From: Antoine du Hamel Date: Sun, 27 Jun 2021 14:25:47 +0200 Subject: [PATCH] doc: use ASCII order for md refs PR-URL: https://github.com/nodejs/node/pull/39170 Refs: https://github.com/nodejs/remark-preset-lint-node/pull/188 Reviewed-By: Rich Trott Reviewed-By: Darshan Sen --- doc/api/assert.md | 4 ++-- doc/api/async_hooks.md | 6 +++--- doc/api/diagnostics_channel.md | 4 ++-- doc/api/esm.md | 4 ++-- doc/api/events.md | 4 ++-- doc/api/fs.md | 2 +- doc/api/http.md | 12 ++++++------ doc/api/http2.md | 4 ++-- doc/api/modules.md | 4 ++-- doc/api/packages.md | 10 +++++----- doc/api/stream.md | 2 +- doc/api/tls.md | 8 ++++---- doc/api/url.md | 2 +- doc/api/worker_threads.md | 6 +++--- src/README.md | 2 +- 15 files changed, 37 insertions(+), 37 deletions(-) diff --git a/doc/api/assert.md b/doc/api/assert.md index 6102efa602aae9..13942c021fad19 100644 --- a/doc/api/assert.md +++ b/doc/api/assert.md @@ -1601,6 +1601,7 @@ argument. [SameValue Comparison]: https://tc39.github.io/ecma262/#sec-samevalue [Strict Equality Comparison]: https://tc39.github.io/ecma262/#sec-strict-equality-comparison [`AssertionError`]: #assert_class_assert_assertionerror +[`CallTracker`]: #assert_class_assert_calltracker [`Class`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes [`ERR_INVALID_RETURN_VALUE`]: errors.md#errors_err_invalid_return_value [`Error.captureStackTrace`]: errors.md#errors_error_capturestacktrace_targetobject_constructoropt @@ -1613,7 +1614,6 @@ argument. [`TypeError`]: errors.md#errors_class_typeerror [`WeakMap`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap [`WeakSet`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet -[`CallTracker`]: #assert_class_assert_calltracker [`assert.deepEqual()`]: #assert_assert_deepequal_actual_expected_message [`assert.deepStrictEqual()`]: #assert_assert_deepstrictequal_actual_expected_message [`assert.doesNotThrow()`]: #assert_assert_doesnotthrow_fn_error_message @@ -1628,6 +1628,6 @@ argument. [`process.on('exit')`]: process.md#process_event_exit [`tracker.calls()`]: #assert_tracker_calls_fn_exact [`tracker.verify()`]: #assert_tracker_verify -[strict assertion mode]: #assert_strict_assertion_mode [enumerable "own" properties]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Enumerability_and_ownership_of_properties [prototype-spec]: https://tc39.github.io/ecma262/#sec-ordinary-object-internal-methods-and-internal-slots +[strict assertion mode]: #assert_strict_assertion_mode diff --git a/doc/api/async_hooks.md b/doc/api/async_hooks.md index c2028f02a40d78..f1c964fc20f4f3 100644 --- a/doc/api/async_hooks.md +++ b/doc/api/async_hooks.md @@ -1196,13 +1196,13 @@ to associate the asynchronous operation with the correct execution context. [Hook Callbacks]: #async_hooks_hook_callbacks [PromiseHooks]: https://docs.google.com/document/d/1rda3yKGHimKIhg5YeoAmCOtyURgsbTH_qaYR79FELlk/edit [`AsyncResource`]: #async_hooks_class_asyncresource +[`EventEmitter`]: events.md#events_class_eventemitter +[`Stream`]: stream.md#stream_stream +[`Worker`]: worker_threads.md#worker_threads_class_worker [`after` callback]: #async_hooks_after_asyncid [`before` callback]: #async_hooks_before_asyncid [`destroy` callback]: #async_hooks_destroy_asyncid [`init` callback]: #async_hooks_init_asyncid_type_triggerasyncid_resource [`promiseResolve` callback]: #async_hooks_promiseresolve_asyncid -[`EventEmitter`]: events.md#events_class_eventemitter -[`Stream`]: stream.md#stream_stream -[`Worker`]: worker_threads.md#worker_threads_class_worker [`util.promisify()`]: util.md#util_util_promisify_original [promise execution tracking]: #async_hooks_promise_execution_tracking diff --git a/doc/api/diagnostics_channel.md b/doc/api/diagnostics_channel.md index f120f34f26ffda..16b47db3bf6cc4 100644 --- a/doc/api/diagnostics_channel.md +++ b/doc/api/diagnostics_channel.md @@ -175,6 +175,6 @@ channel.subscribe(onMessage); channel.unsubscribe(onMessage); ``` -[`diagnostics_channel.channel(name)`]: #diagnostics_channel_diagnostics_channel_channel_name -[`channel.subscribe(onMessage)`]: #diagnostics_channel_channel_subscribe_onmessage [`'uncaughtException'`]: process.md#process_event_uncaughtexception +[`channel.subscribe(onMessage)`]: #diagnostics_channel_channel_subscribe_onmessage +[`diagnostics_channel.channel(name)`]: #diagnostics_channel_diagnostics_channel_channel_name diff --git a/doc/api/esm.md b/doc/api/esm.md index 1f6718e96c8db0..3c0a400b5c4746 100644 --- a/doc/api/esm.md +++ b/doc/api/esm.md @@ -1332,15 +1332,15 @@ success! [`data:` URLs]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs [`export`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/export [`import()`]: #esm_import_expressions -[`import.meta.url`]: #esm_import_meta_url [`import.meta.resolve`]: #esm_import_meta_resolve_specifier_parent +[`import.meta.url`]: #esm_import_meta_url [`import`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import [`module.createRequire()`]: module.md#module_module_createrequire_filename [`module.syncBuiltinESMExports()`]: module.md#module_module_syncbuiltinesmexports [`package.json`]: packages.md#packages_node_js_package_json_field_definitions [`process.dlopen`]: process.md#process_process_dlopen_module_filename_flags -[`transformSource` hook]: #esm_transformsource_source_context_defaulttransformsource [`string`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String +[`transformSource` hook]: #esm_transformsource_source_context_defaulttransformsource [`util.TextDecoder`]: util.md#util_class_util_textdecoder [cjs-module-lexer]: https://github.com/guybedford/cjs-module-lexer/tree/1.2.2 [custom https loader]: #esm_https_loader diff --git a/doc/api/events.md b/doc/api/events.md index 6cb4cf3033a045..5cc49018e0ec11 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -1620,8 +1620,8 @@ to the `EventTarget`. [`fs.ReadStream`]: fs.md#fs_class_fs_readstream [`net.Server`]: net.md#net_class_net_server [`process.on('warning')`]: process.md#process_event_warning -[stream]: stream.md [capturerejections]: #events_capture_rejections_of_promises +[error]: #events_error_events [rejection]: #events_emitter_symbol_for_nodejs_rejection_err_eventname_args [rejectionsymbol]: #events_events_capturerejectionsymbol -[error]: #events_error_events +[stream]: stream.md diff --git a/doc/api/fs.md b/doc/api/fs.md index 396f80afbad146..f20838d0f89b9f 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -6685,7 +6685,6 @@ the file contents. [Naming Files, Paths, and Namespaces]: https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file [Readable Stream]: stream.md#stream_class_stream_readable [Writable Stream]: stream.md#stream_class_stream_writable -[caveats]: #fs_caveats [`AHAFS`]: https://developer.ibm.com/articles/au-aix_event_infrastructure/ [`Buffer.byteLength`]: buffer.md#buffer_static_method_buffer_bytelength_string_encoding [`FSEvents`]: https://developer.apple.com/documentation/coreservices/file_system_events @@ -6735,6 +6734,7 @@ the file contents. [`kqueue(2)`]: https://www.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2 [`util.promisify()`]: util.md#util_util_promisify_original [bigints]: https://tc39.github.io/proposal-bigint +[caveats]: #fs_caveats [chcp]: https://ss64.com/nt/chcp.html [inode]: https://en.wikipedia.org/wiki/Inode [support of file system `flags`]: #fs_file_system_flags diff --git a/doc/api/http.md b/doc/api/http.md index 67be7ec9e6b9f2..fba443f18d14b2 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -3073,13 +3073,13 @@ try { } ``` -[`--insecure-http-parser`]: cli.md#cli_insecure_http_parser -[`--max-http-header-size`]: cli.md#cli_max_http_header_size_size [`'checkContinue'`]: #http_event_checkcontinue [`'finish'`]: #http_event_finish [`'request'`]: #http_event_request [`'response'`]: #http_event_response [`'upgrade'`]: #http_event_upgrade +[`--insecure-http-parser`]: cli.md#cli_insecure_http_parser +[`--max-http-header-size`]: cli.md#cli_max_http_header_size_size [`Agent`]: #http_class_http_agent [`Buffer.byteLength()`]: buffer.md#buffer_static_method_buffer_bytelength_string_encoding [`Duplex`]: stream.md#stream_class_stream_duplex @@ -3095,8 +3095,8 @@ try { [`http.Agent`]: #http_class_http_agent [`http.ClientRequest`]: #http_class_http_clientrequest [`http.IncomingMessage`]: #http_class_http_incomingmessage -[`http.Server`]: #http_class_http_server [`http.ServerResponse`]: #http_class_http_serverresponse +[`http.Server`]: #http_class_http_server [`http.get()`]: #http_http_get_options_callback [`http.globalAgent`]: #http_http_globalagent [`http.request()`]: #http_http_request_options_callback @@ -3108,23 +3108,23 @@ try { [`new URL()`]: url.md#url_new_url_input_base [`outgoingMessage.socket`]: #http_outgoingMessage.socket [`removeHeader(name)`]: #http_request_removeheader_name -[`request.end()`]: #http_request_end_data_encoding_callback [`request.destroy()`]: #http_request_destroy_error +[`request.end()`]: #http_request_end_data_encoding_callback [`request.flushHeaders()`]: #http_request_flushheaders [`request.getHeader()`]: #http_request_getheader_name [`request.setHeader()`]: #http_request_setheader_name_value [`request.setTimeout()`]: #http_request_settimeout_timeout_callback [`request.socket.getPeerCertificate()`]: tls.md#tls_tlssocket_getpeercertificate_detailed [`request.socket`]: #http_request_socket -[`request.writableFinished`]: #http_request_writablefinished [`request.writableEnded`]: #http_request_writableended +[`request.writableFinished`]: #http_request_writablefinished [`request.write(data, encoding)`]: #http_request_write_chunk_encoding_callback [`response.end()`]: #http_response_end_data_encoding_callback [`response.getHeader()`]: #http_response_getheader_name [`response.setHeader()`]: #http_response_setheader_name_value [`response.socket`]: #http_response_socket -[`response.writableFinished`]: #http_response_writablefinished [`response.writableEnded`]: #http_response_writableended +[`response.writableFinished`]: #http_response_writablefinished [`response.write()`]: #http_response_write_chunk_encoding_callback [`response.write(data, encoding)`]: #http_response_write_chunk_encoding_callback [`response.writeContinue()`]: #http_response_writecontinue diff --git a/doc/api/http2.md b/doc/api/http2.md index 46a0cd37270d9a..1b1296203dd594 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -3807,6 +3807,7 @@ following additional properties: [RFC 7838]: https://tools.ietf.org/html/rfc7838 [RFC 8336]: https://tools.ietf.org/html/rfc8336 [RFC 8441]: https://tools.ietf.org/html/rfc8441 +[Sensitive headers]: #http2_sensitive_headers [`'checkContinue'`]: #http2_event_checkcontinue [`'connect'`]: #http2_event_connect [`'request'`]: #http2_event_request @@ -3835,8 +3836,8 @@ following additional properties: [`net.Socket`]: net.md#net_class_net_socket [`net.connect()`]: net.md#net_net_connect [`net.createServer()`]: net.md#net_net_createserver_options_connectionlistener -[`request.socket`]: #http2_request_socket [`request.socket.getPeerCertificate()`]: tls.md#tls_tlssocket_getpeercertificate_detailed +[`request.socket`]: #http2_request_socket [`response.end()`]: #http2_response_end_data_encoding_callback [`response.setHeader()`]: #http2_response_setheader_name_value [`response.socket`]: #http2_response_socket @@ -3851,4 +3852,3 @@ following additional properties: [`tls.createServer()`]: tls.md#tls_tls_createserver_options_secureconnectionlistener [`writable.writableFinished`]: stream.md#stream_writable_writablefinished [error code]: #http2_error_codes_for_rst_stream_and_goaway -[Sensitive headers]: #http2_sensitive_headers diff --git a/doc/api/modules.md b/doc/api/modules.md index b7ab596a26ac08..5d28ffec886bd5 100644 --- a/doc/api/modules.md +++ b/doc/api/modules.md @@ -1011,9 +1011,9 @@ This section was moved to [`Error`]: errors.md#errors_class_error [`__dirname`]: #modules_dirname [`__filename`]: #modules_filename -[`module` object]: #modules_the_module_object -[`module.id`]: #modules_module_id [`module.children`]: #modules_module_children +[`module.id`]: #modules_module_id +[`module` object]: #modules_the_module_object [`package.json`]: packages.md#packages_node_js_package_json_field_definitions [`path.dirname()`]: path.md#path_path_dirname_path [`require.main`]: #modules_require_main diff --git a/doc/api/packages.md b/doc/api/packages.md index 8a984574056a1a..637159476aeede 100644 --- a/doc/api/packages.md +++ b/doc/api/packages.md @@ -1126,22 +1126,22 @@ Import maps permit mapping to external packages. This field defines [subpath imports][] for the current package. [Babel]: https://babeljs.io/ -[Conditional exports]: #packages_conditional_exports [CommonJS]: modules.md +[Conditional exports]: #packages_conditional_exports [ES module]: esm.md [ES modules]: esm.md [Node.js documentation for this section]: https://github.com/nodejs/node/blob/HEAD/doc/api/packages.md#conditions-definitions -[`ERR_PACKAGE_PATH_NOT_EXPORTED`]: errors.md#errors_err_package_path_not_exported -[`esm`]: https://github.com/standard-things/esm#readme [`"exports"`]: #packages_exports +[`"imports"`]: #packages_imports [`"main"`]: #packages_main [`"name"`]: #packages_name -[`"imports"`]: #packages_imports [`"type"`]: #packages_type +[`ERR_PACKAGE_PATH_NOT_EXPORTED`]: errors.md#errors_err_package_path_not_exported +[`esm`]: https://github.com/standard-things/esm#readme [`package.json`]: #packages_node_js_package_json_field_definitions [entry points]: #packages_package_entry_points [self-reference]: #packages_self_referencing_a_package_using_its_name [subpath exports]: #packages_subpath_exports [subpath imports]: #packages_subpath_imports -[the full specifier path]: esm.md#esm_mandatory_file_extensions [the dual CommonJS/ES module packages section]: #packages_dual_commonjs_es_module_packages +[the full specifier path]: esm.md#esm_mandatory_file_extensions diff --git a/doc/api/stream.md b/doc/api/stream.md index 64045f01608121..3af13addda1bb8 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -2956,6 +2956,7 @@ contain multi-byte characters. [HTTP requests, on the client]: http.md#http_class_http_clientrequest [HTTP responses, on the server]: http.md#http_class_http_serverresponse [TCP sockets]: net.md#net_class_net_socket +[Three states]: #stream_three_states [`'data'`]: #stream_event_data [`'drain'`]: #stream_event_drain [`'end'`]: #stream_event_end @@ -3015,7 +3016,6 @@ contain multi-byte characters. [stream-resume]: #stream_readable_resume [stream-uncork]: #stream_writable_uncork [stream-write]: #stream_writable_write_chunk_encoding_callback -[Three states]: #stream_three_states [writable-_destroy]: #stream_writable_destroy_err_callback [writable-destroy]: #stream_writable_destroy_error [writable-new]: #stream_new_stream_writable_options diff --git a/doc/api/tls.md b/doc/api/tls.md index 74288e7bb3d2ed..548766604502dd 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -2012,14 +2012,14 @@ added: v11.4.0 [Session Resumption]: #tls_session_resumption [Stream]: stream.md#stream_stream [TLS recommendations]: https://wiki.mozilla.org/Security/Server_Side_TLS -[`--tls-cipher-list`]: cli.md#cli_tls_cipher_list_list -[`Duplex`]: stream.md#stream_class_stream_duplex -[`NODE_OPTIONS`]: cli.md#cli_node_options_options [`'newSession'`]: #tls_event_newsession [`'resumeSession'`]: #tls_event_resumesession [`'secureConnect'`]: #tls_event_secureconnect [`'secureConnection'`]: #tls_event_secureconnection [`'session'`]: #tls_event_session +[`--tls-cipher-list`]: cli.md#cli_tls_cipher_list_list +[`Duplex`]: stream.md#stream_class_stream_duplex +[`NODE_OPTIONS`]: cli.md#cli_node_options_options [`SSL_export_keying_material`]: https://www.openssl.org/docs/man1.1.1/man3/SSL_export_keying_material.html [`SSL_get_version`]: https://www.openssl.org/docs/man1.1.1/man3/SSL_get_version.html [`crypto.getCurves()`]: crypto.md#crypto_crypto_getcurves @@ -2053,5 +2053,5 @@ added: v11.4.0 [cipher list format]: https://www.openssl.org/docs/man1.1.1/man1/ciphers.html#CIPHER-LIST-FORMAT [forward secrecy]: https://en.wikipedia.org/wiki/Perfect_forward_secrecy [modifying the default cipher suite]: #tls_modifying_the_default_tls_cipher_suite -[specific attacks affecting larger AES key sizes]: https://www.schneier.com/blog/archives/2009/07/another_new_aes.html [perfect forward secrecy]: #tls_perfect_forward_secrecy +[specific attacks affecting larger AES key sizes]: https://www.schneier.com/blog/archives/2009/07/another_new_aes.html diff --git a/doc/api/url.md b/doc/api/url.md index dfc9583395b38a..07311bd64c458f 100644 --- a/doc/api/url.md +++ b/doc/api/url.md @@ -1521,8 +1521,8 @@ console.log(myURL.origin); [ICU]: intl.md#intl_options_for_building_node_js [Punycode]: https://tools.ietf.org/html/rfc5891#section-4.4 -[WHATWG URL Standard]: https://url.spec.whatwg.org/ [WHATWG URL]: #url_the_whatwg_url_api +[WHATWG URL Standard]: https://url.spec.whatwg.org/ [`Error`]: errors.md#errors_class_error [`JSON.stringify()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify [`Map`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md index e9e5845d4ca19a..f662fec36cd1e6 100644 --- a/doc/api/worker_threads.md +++ b/doc/api/worker_threads.md @@ -1096,6 +1096,7 @@ thread spawned will spawn another until the application crashes. [`SharedArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer [`Uint8Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array [`WebAssembly.Module`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/Module +[`Worker constructor options`]: #worker_threads_new_worker_filename_options [`Worker`]: #worker_threads_class_worker [`cluster` module]: cluster.md [`data:` URL]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs @@ -1118,17 +1119,16 @@ thread spawned will spawn another until the application crashes. [`process.title`]: process.md#process_process_title [`require('worker_threads').isMainThread`]: #worker_threads_worker_ismainthread [`require('worker_threads').parentPort.on('message')`]: #worker_threads_event_message -[`require('worker_threads').parentPort`]: #worker_threads_worker_parentport [`require('worker_threads').parentPort.postMessage()`]: #worker_threads_worker_postmessage_value_transferlist +[`require('worker_threads').parentPort`]: #worker_threads_worker_parentport [`require('worker_threads').threadId`]: #worker_threads_worker_threadid [`require('worker_threads').workerData`]: #worker_threads_worker_workerdata [`trace_events`]: tracing.md [`v8.getHeapSnapshot()`]: v8.md#v8_v8_getheapsnapshot [`vm`]: vm.md -[`Worker constructor options`]: #worker_threads_new_worker_filename_options +[`worker.SHARE_ENV`]: #worker_threads_worker_share_env [`worker.on('message')`]: #worker_threads_event_message_1 [`worker.postMessage()`]: #worker_threads_worker_postmessage_value_transferlist -[`worker.SHARE_ENV`]: #worker_threads_worker_share_env [`worker.terminate()`]: #worker_threads_worker_terminate [`worker.threadId`]: #worker_threads_worker_threadid_1 [async-resource-worker-pool]: async_hooks.md#async-resource-worker-pool diff --git a/src/README.md b/src/README.md index b278c0287366cf..91b9f3817a36b0 100644 --- a/src/README.md +++ b/src/README.md @@ -1036,7 +1036,7 @@ static void GetUserInfo(const FunctionCallbackInfo& args) { [exception handling]: #exception-handling [internal field]: #internal-fields [introduction for V8 embedders]: https://v8.dev/docs/embed +[libuv]: https://libuv.org/ [libuv handles]: #libuv-handles-and-requests [libuv requests]: #libuv-handles-and-requests -[libuv]: https://libuv.org/ [reference documentation for the libuv API]: http://docs.libuv.org/en/v1.x/