Browse Source

GIT-INFO: convert to markdown

Closes #13074
Daniel Stenberg 1 month ago
parent
commit
1347cf255b
7 changed files with 22 additions and 22 deletions
  1. 1 1
      .github/labeler.yml
  2. 2 0
      .github/scripts/spellcheck.words
  3. 1 1
      .reuse/dep5
  4. 14 16
      GIT-INFO.md
  5. 1 1
      buildconf.bat
  6. 2 2
      docs/INSTALL.md
  7. 1 1
      projects/generate.bat

+ 1 - 1
.github/labeler.yml

@@ -93,7 +93,7 @@ documentation:
   - all:
       - changed-files:
           - any-glob-to-all-files:
-              - '{.github/workflows/badwords.yml,.github/workflows/man-examples.yml,.github/workflows/synopsis.yml,.github/scripts/badwords.*,.github/scripts/cd2cd,.github/scripts/cd2nroff,.github/scripts/cdall.pl,.github/scripts/nroff2cd,.github/scripts/verify-examples.pl,.github/scripts/verify-synopsis.pl,**/*.md,**/*.txt,**/*.1,CHANGES,docs/**,GIT-INFO,LICENSES/**,README,RELEASE-NOTES,scripts/cd*}'
+              - '{.github/workflows/badwords.yml,.github/workflows/man-examples.yml,.github/workflows/synopsis.yml,.github/scripts/badwords.*,.github/scripts/cd2cd,.github/scripts/cd2nroff,.github/scripts/cdall.pl,.github/scripts/nroff2cd,.github/scripts/verify-examples.pl,.github/scripts/verify-synopsis.pl,**/*.md,**/*.txt,**/*.1,CHANGES,docs/**,LICENSES/**,README,RELEASE-NOTES,scripts/cd*}'
           - all-globs-to-all-files:
               # negative matches
               - '!**/CMakeLists.txt'

+ 2 - 0
.github/scripts/spellcheck.words

@@ -41,6 +41,7 @@ autobuilds
 Autoconf
 autoconf
 Automake
+automake
 Autotools
 autotools
 AVR
@@ -426,6 +427,7 @@ libssh
 libSSH
 libssh2
 Libtool
+libtool
 libuv
 libWebSocket
 libz

+ 1 - 1
.reuse/dep5

@@ -32,7 +32,7 @@ Files: CHANGES
 Copyright: Daniel Stenberg, <daniel@haxx.se>, et al.
 License: curl
 
-Files: GIT-INFO
+Files: GIT-INFO.md
 Copyright: Daniel Stenberg, <daniel@haxx.se>, et al.
 License: curl
 

+ 14 - 16
GIT-INFO → GIT-INFO.md

@@ -4,7 +4,7 @@
                             | (__| |_| |  _ <| |___
                              \___|\___/|_| \_\_____|
 
-GIT-INFO
+# GIT-INFO
 
 This file is only present in git - never in release archives. It contains
 information about other files and things that the git repository keeps in its
@@ -13,32 +13,30 @@ inner sanctum.
 To build in environments that support configure, after having extracted
 everything from git, do this:
 
-autoreconf -fi
-./configure --with-openssl
-make
+    autoreconf -fi
+    ./configure --with-openssl
+    make
 
-  Daniel uses a ./configure line similar to this for easier development:
+Daniel uses a configure line similar to this for easier development:
 
-  ./configure --disable-shared --enable-debug --enable-maintainer-mode
+    ./configure --disable-shared --enable-debug --enable-maintainer-mode
 
-In environments that don't support configure (i.e. Microsoft), do this:
+In environments that don't support configure (i.e. Windows), do this:
 
-buildconf.bat
+    buildconf.bat
 
+## REQUIREMENTS
 
-REQUIREMENTS
-
-For autoreconf and configure (not buildconf.bat) to work, you need the
+For `autoreconf` and `configure` (not `buildconf.bat`) to work, you need the
 following software installed:
 
  o autoconf 2.57  (or later)
  o automake 1.7   (or later)
  o libtool  1.4.2 (or later)
  o GNU m4 (required by autoconf)
-
  o perl
 
-   If you don't have perl and don't want to install it, you can rename the
-   source file src/tool_hugehelp.c.cvs to src/tool_hugehelp.c and avoid having
-   to generate this file. This will give you a stubbed version of the file
-   that doesn't contain actual content.
+If you don't have perl and don't want to install it, you can rename the source
+file `src/tool_hugehelp.c.cvs` to `src/tool_hugehelp.c` and avoid having to
+generate this file. This will give you a stubbed version of the file that
+doesn't contain actual content.

+ 1 - 1
buildconf.bat

@@ -38,7 +38,7 @@ rem
   cd /d "%~0\.." 1>NUL 2>&1
 
   rem Check we are running from a curl git repository
-  if not exist GIT-INFO goto norepo
+  if not exist GIT-INFO.md goto norepo
 
   rem Detect programs. HAVE_<PROGNAME>
   rem When not found the variable is set undefined. The undefined pattern

+ 2 - 2
docs/INSTALL.md

@@ -24,8 +24,8 @@ or pull request](https://github.com/Microsoft/vcpkg) on the vcpkg repository.
 ## Building from git
 
 If you get your code off a git repository instead of a release tarball, see
-the `GIT-INFO` file in the root directory for specific instructions on how to
-proceed.
+the `GIT-INFO.md` file in the root directory for specific instructions on how
+to proceed.
 
 # Unix
 

+ 1 - 1
projects/generate.bat

@@ -39,7 +39,7 @@ rem ***************************************************************************
   cd /d "%~0\.." 1>NUL 2>&1
 
   rem Check we are running from a curl git repository
-  if not exist ..\GIT-INFO goto norepo
+  if not exist ..\GIT-INFO.md goto norepo
 
 :parseArgs
   if "%~1" == "" goto start