]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
GIT-INFO: convert to markdown
authorDaniel Stenberg <daniel@haxx.se>
Thu, 7 Mar 2024 08:28:06 +0000 (09:28 +0100)
committerDaniel Stenberg <daniel@haxx.se>
Thu, 7 Mar 2024 08:43:33 +0000 (09:43 +0100)
Closes #13074

.github/labeler.yml
.github/scripts/spellcheck.words
.reuse/dep5
GIT-INFO.md [moved from GIT-INFO with 51% similarity]
buildconf.bat
docs/INSTALL.md
projects/generate.bat

index bd5a027c790fd5e5d490fc44cf87679b404cb06f..c22bd6e485fbc4b11f4064729d39844615f8a593 100644 (file)
@@ -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'
index d851228688fce003f25ad20bb192b7046fb1321e..ab7b18c1f5a082eea8e413f1eb72f3c97ccb51f1 100644 (file)
@@ -41,6 +41,7 @@ autobuilds
 Autoconf
 autoconf
 Automake
+automake
 Autotools
 autotools
 AVR
@@ -426,6 +427,7 @@ libssh
 libSSH
 libssh2
 Libtool
+libtool
 libuv
 libWebSocket
 libz
index 60c9a012dd27015ac2fe921223f6fe9a4ffd9c3b..d51e5b9ce101d77f284a00775e800cb58271c87b 100644 (file)
@@ -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
 
similarity index 51%
rename from GIT-INFO
rename to GIT-INFO.md
index 6e2bfad5cffd44d2edbc10e01151a02d96163b3c..825476c96ceac740b4966b7169a2919a52aaca5d 100644 (file)
--- a/GIT-INFO
@@ -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.
index 6153661185809ebfddb876aa87862634ebd44933..afe59e50d729f13f13a988f215351756e7a0288b 100644 (file)
@@ -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
index e8559ea4a780d0f9d2e3fedab399161ed7c4aea6..7971b1abaaf5f6f19e90ba2f1caa29dd23f0bdbb 100644 (file)
@@ -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
 
index a110adffc3d9a70fecd4f1bd1e9e99cbd8e51465..9c41d34fb730885f00b17a30031d3d0fe90b5c2f 100644 (file)
@@ -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