From bceae310fb97823f5e4d605a0ec00c3ad5eb9fab Mon Sep 17 00:00:00 2001 From: Fabrizio Date: Tue, 22 Nov 2022 21:32:40 +0100 Subject: [PATCH] fixes #671 Same issue as in #634, links in md files included in md files from other folders will have wrong relative path in one of the two locations. in this case the root file development_tools.md was working and the debugging.md was broken. --- src/development_tools.md | 47 +++++++++++++++++++++--------- src/development_tools/debugging.md | 40 ++++++++++++------------- 2 files changed, 54 insertions(+), 33 deletions(-) diff --git a/src/development_tools.md b/src/development_tools.md index 94b167ab..eb41b1e8 100644 --- a/src/development_tools.md +++ b/src/development_tools.md @@ -1,31 +1,52 @@ # Development Tools -{{#include development_tools/debugging.md}} +## Debugging + +| Recipe | Crates | Categories | +| -------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | --------------------------------------- | +| [Log a debug message to the console][ex-log-debug] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] | +| [Log an error message to the console][ex-log-error] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] | +| [Log to stdout instead of stderr][ex-log-stdout] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] | +| [Log messages with a custom logger][ex-log-custom-logger] | [![log-badge]][log] | [![cat-debugging-badge]][cat-debugging] | +| [Log to the Unix syslog][ex-log-syslog] | [![log-badge]][log] [![syslog-badge]][syslog] | [![cat-debugging-badge]][cat-debugging] | +| [Enable log levels per module][ex-log-mod] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] | +| [Use a custom environment variable to set up logging][ex-log-env-variable] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] | +| [Include timestamp in log messages][ex-log-timestamp] | [![log-badge]][log] [![env_logger-badge]][env_logger] [![chrono-badge]][chrono] | [![cat-debugging-badge]][cat-debugging] | +| [Log messages to a custom location][ex-log-custom] | [![log-badge]][log] [![log4rs-badge]][log4rs] | [![cat-debugging-badge]][cat-debugging] | + +[ex-log-debug]: development_tools/debugging/log.html#log-a-debug-message-to-the-console +[ex-log-error]: development_tools/debugging/log.html#log-an-error-message-to-the-console +[ex-log-stdout]: development_tools/debugging/log.html#log-to-stdout-instead-of-stderr +[ex-log-custom-logger]: development_tools/debugging/log.html#log-messages-with-a-custom-logger +[ex-log-syslog]: development_tools/debugging/log.html#log-to-the-unix-syslog +[ex-log-mod]: development_tools/debugging/config_log.html#enable-log-levels-per-module +[ex-log-env-variable]: development_tools/debugging/config_log.html#use-a-custom-environment-variable-to-set-up-logging +[ex-log-timestamp]: development_tools/debugging/config_log.html#include-timestamp-in-log-messages +[ex-log-custom]: development_tools/debugging/config_log.html#log-messages-to-a-custom-location ## Versioning -| Recipe | Crates | Categories | -|--------|--------|------------| -| [Parse and increment a version string][ex-semver-increment] | [![semver-badge]][semver] | [![cat-config-badge]][cat-config] | -| [Parse a complex version string][ex-semver-complex] | [![semver-badge]][semver] | [![cat-config-badge]][cat-config] | -| [Check if given version is pre-release][ex-semver-prerelease] | [![semver-badge]][semver] | [![cat-config-badge]][cat-config] | -| [Find the latest version satisfying given range][ex-semver-latest] | [![semver-badge]][semver] | [![cat-config-badge]][cat-config] | -| [Check external command version for compatibility][ex-semver-command] | [![semver-badge]][semver] | [![cat-text-processing-badge]][cat-text-processing] [![cat-os-badge]][cat-os] +| Recipe | Crates | Categories | +| --------------------------------------------------------------------- | ------------------------- | ----------------------------------------------------------------------------- | +| [Parse and increment a version string][ex-semver-increment] | [![semver-badge]][semver] | [![cat-config-badge]][cat-config] | +| [Parse a complex version string][ex-semver-complex] | [![semver-badge]][semver] | [![cat-config-badge]][cat-config] | +| [Check if given version is pre-release][ex-semver-prerelease] | [![semver-badge]][semver] | [![cat-config-badge]][cat-config] | +| [Find the latest version satisfying given range][ex-semver-latest] | [![semver-badge]][semver] | [![cat-config-badge]][cat-config] | +| [Check external command version for compatibility][ex-semver-command] | [![semver-badge]][semver] | [![cat-text-processing-badge]][cat-text-processing] [![cat-os-badge]][cat-os] | ## Build Time -| Recipe | Crates | Categories | -|--------|--------|------------| -| [Compile and link statically to a bundled C library][ex-cc-static-bundled] | [![cc-badge]][cc] | [![cat-development-tools-badge]][cat-development-tools] | +| Recipe | Crates | Categories | +| -------------------------------------------------------------------------------- | ----------------- | ------------------------------------------------------- | +| [Compile and link statically to a bundled C library][ex-cc-static-bundled] | [![cc-badge]][cc] | [![cat-development-tools-badge]][cat-development-tools] | | [Compile and link statically to a bundled C++ library][ex-cc-static-bundled-cpp] | [![cc-badge]][cc] | [![cat-development-tools-badge]][cat-development-tools] | -| [Compile a C library while setting custom defines][ex-cc-custom-defines] | [![cc-badge]][cc] | [![cat-development-tools-badge]][cat-development-tools] | +| [Compile a C library while setting custom defines][ex-cc-custom-defines] | [![cc-badge]][cc] | [![cat-development-tools-badge]][cat-development-tools] | [ex-semver-increment]: development_tools/versioning.html#parse-and-increment-a-version-string [ex-semver-complex]: development_tools/versioning.html#parse-a-complex-version-string [ex-semver-prerelease]: development_tools/versioning.html#check-if-given-version-is-pre-release [ex-semver-latest]: development_tools/versioning.html#find-the-latest-version-satisfying-given-range [ex-semver-command]: development_tools/versioning.html#check-external-command-version-for-compatibility - [ex-cc-static-bundled]: development_tools/build_tools.html#compile-and-link-statically-to-a-bundled-c-library [ex-cc-static-bundled-cpp]: development_tools/build_tools.html#compile-and-link-statically-to-a-bundled-c-library-1 [ex-cc-custom-defines]: development_tools/build_tools.html#compile-a-c-library-while-setting-custom-defines diff --git a/src/development_tools/debugging.md b/src/development_tools/debugging.md index 6786f8bf..c9215758 100644 --- a/src/development_tools/debugging.md +++ b/src/development_tools/debugging.md @@ -1,25 +1,25 @@ ## Debugging -| Recipe | Crates | Categories | -|--------|--------|------------| -| [Log a debug message to the console][ex-log-debug] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] | -| [Log an error message to the console][ex-log-error] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] | -| [Log to stdout instead of stderr][ex-log-stdout] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] | -| [Log messages with a custom logger][ex-log-custom-logger] | [![log-badge]][log] | [![cat-debugging-badge]][cat-debugging] | -| [Log to the Unix syslog][ex-log-syslog] | [![log-badge]][log] [![syslog-badge]][syslog] | [![cat-debugging-badge]][cat-debugging] | -| [Enable log levels per module][ex-log-mod] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] | -| [Use a custom environment variable to set up logging][ex-log-env-variable] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] | -| [Include timestamp in log messages][ex-log-timestamp] | [![log-badge]][log] [![env_logger-badge]][env_logger] [![chrono-badge]][chrono] | [![cat-debugging-badge]][cat-debugging] | -| [Log messages to a custom location][ex-log-custom] | [![log-badge]][log] [![log4rs-badge]][log4rs] | [![cat-debugging-badge]][cat-debugging] | +| Recipe | Crates | Categories | +| -------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | --------------------------------------- | +| [Log a debug message to the console][ex-log-debug] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] | +| [Log an error message to the console][ex-log-error] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] | +| [Log to stdout instead of stderr][ex-log-stdout] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] | +| [Log messages with a custom logger][ex-log-custom-logger] | [![log-badge]][log] | [![cat-debugging-badge]][cat-debugging] | +| [Log to the Unix syslog][ex-log-syslog] | [![log-badge]][log] [![syslog-badge]][syslog] | [![cat-debugging-badge]][cat-debugging] | +| [Enable log levels per module][ex-log-mod] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] | +| [Use a custom environment variable to set up logging][ex-log-env-variable] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] | +| [Include timestamp in log messages][ex-log-timestamp] | [![log-badge]][log] [![env_logger-badge]][env_logger] [![chrono-badge]][chrono] | [![cat-debugging-badge]][cat-debugging] | +| [Log messages to a custom location][ex-log-custom] | [![log-badge]][log] [![log4rs-badge]][log4rs] | [![cat-debugging-badge]][cat-debugging] | -[ex-log-debug]: development_tools/debugging/log.html#log-a-debug-message-to-the-console -[ex-log-error]: development_tools/debugging/log.html#log-an-error-message-to-the-console -[ex-log-stdout]: development_tools/debugging/log.html#log-to-stdout-instead-of-stderr -[ex-log-custom-logger]: development_tools/debugging/log.html#log-messages-with-a-custom-logger -[ex-log-syslog]: development_tools/debugging/log.html#log-to-the-unix-syslog -[ex-log-mod]: development_tools/debugging/config_log.html#enable-log-levels-per-module -[ex-log-env-variable]: development_tools/debugging/config_log.html#use-a-custom-environment-variable-to-set-up-logging -[ex-log-timestamp]: development_tools/debugging/config_log.html#include-timestamp-in-log-messages -[ex-log-custom]: development_tools/debugging/config_log.html#log-messages-to-a-custom-location +[ex-log-debug]: debugging/log.html#log-a-debug-message-to-the-console +[ex-log-error]: debugging/log.html#log-an-error-message-to-the-console +[ex-log-stdout]: debugging/log.html#log-to-stdout-instead-of-stderr +[ex-log-custom-logger]: debugging/log.html#log-messages-with-a-custom-logger +[ex-log-syslog]: debugging/log.html#log-to-the-unix-syslog +[ex-log-mod]: debugging/config_log.html#enable-log-levels-per-module +[ex-log-env-variable]: debugging/config_log.html#use-a-custom-environment-variable-to-set-up-logging +[ex-log-timestamp]: debugging/config_log.html#include-timestamp-in-log-messages +[ex-log-custom]: debugging/config_log.html#log-messages-to-a-custom-location {{#include ../links.md}}