*: fix typos in command names

[gutjuri]

Adresses #5071

This PR includes a script that detects pages in which the filename doesn't match the page title. I've run this script and detected several typos, which are fixed by this PR.

There are cases in which a filename-title mismatch is desired, which is why we cannot put this script into the CI.

I am unsure about the titles of the following pages:

• https://github.com/tldr-pages/tldr/blob/main/pages/common/nix-classic.md
• https://github.com/tldr-pages/tldr/blob/main/pages/linux/qm-move-disk.md (-> qm-move_disk.md?)
• nix3-*.md (-> nix-*.md?)

[tldr-bot]

Hello! I've noticed something unusual when checking this PR:

• The page pages.de/common/g++.md is outdated, based on number of commands.
• The page pages.pt_BR/common/g++.md is outdated, based on number of commands.

Is this intended? If so, just ignore this comment. Otherwise, please double-check the commits.

[kant]

LGTM

[kbdharun]

The overall changes and script addition LGTM, thanks for your contribution. I have a few minor suggestions.

[gutjuri]

Thanks for you feedback! Could one of the reviewers be so kind as to address the issue of the pages I'm not sure about? (See OP)

[kbdharun]

Thanks for you feedback! Could one of the reviewers be so kind as to address the issue of the pages I'm not sure about? (See OP)

It seems kind of similar to the discussion at #8786 (I will probably add an entry to the tracker issue to document how to deal with name collisions.)

Addressing your initial queries:

• nix3-.md (-> nix-.md?): We shouldn't do this renaming as the commands aren't the same and some are experimental so both the nix and nix3 ones are necessary. (feel free to checkout Nix: update and add documentation for nix subcommands #9959 (comment))
  • Nix commands documentation is always problematic because commands like nix-build and nix build have different syntax/features the first being stable and the second being experimental (If you aren't aware of Nix, basically stable commands are currently used standardized commands written in a format whereas the nix3 commands and nix commands are experimental ones which might become stable in future or get dropped or made by a different team), both the commands are widely used by the community and it's documentation is a bit hard to interpret for a non-technical audience so this is a group where having tldr cheatsheets will most help. (as Nix is a very useful declarative package manager)
• Regarding, nix-classic IG it is fine to leave it as it is for the above reasons.
• For qm move_disk you can rename the title and description to refer to the commonly used qm move-disk alias alone.

[tldr-bot]

Hello! I've noticed something unusual when checking this PR:

• The page pages.de/common/g++.md is outdated, based on number of commands.
• The page pages.pt_BR/common/g++.md is outdated, based on number of commands.
• The page pages/linux/qm-move_disk.md seems to be a copy of pages/linux/qm-resize.md (58% matching).

Is this intended? If so, just ignore this comment. Otherwise, please double-check the commits.

[sebastiaanspeck]

Looking at the last run of the tldr-maintenance, I found out that https://github.com/tldr-pages/tldr/blob/main/pages/linux/qm-importdisk.md?plain=1 had to be renamed to qm-import-disk OR the Dutch page didn’t need a rename of file/command. Now they don’t match with each other.

[kbdharun]

Looking at the last run of the tldr-maintenance, I found out that https://github.com/tldr-pages/tldr/blob/main/pages/linux/qm-importdisk.md?plain=1 had to be renamed to qm-import-disk OR the Dutch page didn’t need a rename of file/command. Now they don’t match with each other.

This is intentional as suggested in the above discussion where we separated it into two alias pages (to follow the standard alias page template), feel free to update the Dutch translation.

[sebastiaanspeck]

Looking at the last run of the tldr-maintenance, I found out that https://github.com/tldr-pages/tldr/blob/main/pages/linux/qm-importdisk.md?plain=1 had to be renamed to qm-import-disk OR the Dutch page didn’t need a rename of file/command. Now they don’t match with each other.

This is intentional as suggested in the above discussion where we separated it into two alias pages (to follow the standard alias page template), feel free to update the Dutch translation.

I am talking about the import disk command. All I can see is a discussion about move disk.

[kbdharun]

I am talking about the import disk command. All I can see is a discussion about move disk.

Sorry, I confused a bit. Yeah, we can rename this to match with the translations.

[sbrl]

Could use a description of what the script does here :-)

[kbdharun]

Sure, I am working on the remaining entries of the tracker issue now, will do this along with adding documentation for the scripts directory.

[sebastiaanspeck]

Could use a description of what the script does here :-)

And maybe be improved.. right now it doesn't work on MacOS (head: illegal byte count -- -4) and it reports false positives, mainly for pages with -- (acme.sh-dns.md: # acme.sh --dns).

[kbdharun]

Yeah, I am reworking it to something like this (will check your suggestion too):

#!/bin/sh
# SPDX-License-Identifier: MIT
#
# This script checks consistency between the filenames and the page
# title.
#
# Usage: ./scripts/wrong-filename.sh

# Output file for recording inconsistencies
OUTPUT_FILE="filename-consistency-check-output.txt"
# Remove existing output file (if any)
rm -f "$OUTPUT_FILE"

set -e

# Iterate through all Markdown files in the 'pages' directories
for path in $(find pages* -name '*.md' -type f); do
  # Extract the expected command name from the filename
  COMMAND_NAME_FILE=$(basename "$path" | head -c-4 | tr '-' ' ' | tr '[:upper:]' '[:lower:]')

  # Extract the command name from the first line of the Markdown file
  COMMAND_NAME_PAGE=$(head -n1 "$path" | tail -c+3 | tr '-' ' ' | tr '[:upper:]' '[:lower:]')

  # Check if there is a mismatch between filename and content command names
  if [ "$COMMAND_NAME_FILE" != "$COMMAND_NAME_PAGE" ]; then
    echo "Inconsistency found in file: $path" >> "$OUTPUT_FILE"
    echo "Expected: $COMMAND_NAME_FILE" >> "$OUTPUT_FILE"
    echo "Actual  : $COMMAND_NAME_PAGE" >> "$OUTPUT_FILE"
    echo "" >> "$OUTPUT_FILE"
  fi
done

echo "Filename consistency check completed. Output written to: $OUTPUT_FILE"

I had a second thought so instead of documenting the scripts in separate files I am adding them to the existing files header.

[kbdharun]

Seems like head -c doesn't seem to be supported on Mac, will try out something different instead (will DM you the script to test).

[kbdharun]

Done #11810. Feel free to suggest any changes.

[sbrl]

Hey, thanks for the script @gutjuri! Looks useful <3