Skip to content

Commit 34d76b8

Browse files
committed
README: add instructions for missing INSTALL file
The file INSTALL has been dropped in 2009 with [1] and it has been replaced by the INSTALL file generated by automake. The file INSTALL is only present in official releases of OpenOCD and not in the code cloned from git. Add a note in README to report this inconsistency. Change-Id: I881b4282550a80bd5a6c61baff05543714a2e9c5 Reported-by: Mats <[email protected]> Signed-off-by: Antonio Borneo <[email protected]> Fixes: https://sourceforge.net/p/openocd/tickets/451/ Link: [1] commit ef733b4 ("Switch automake handling to use --gnu mode, not --foreign. Remove INSTALL file; automake generates a copy of the latest version.") Reviewed-on: https://review.openocd.org/c/openocd/+/9121 Tested-by: jenkins
1 parent 5fa74d4 commit 34d76b8

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,11 @@ and compiling the OpenOCD source code. That file is provided by
191191
default for all GNU autotools packages. If you are not familiar with
192192
the GNU autotools, then you should read those instructions first.
193193

194+
Note: if the INSTALL file is not present, it means you are using the
195+
source code from a development branch, not from an OpenOCD release.
196+
In this case, follow the instructions 'Compiling OpenOCD' below and
197+
the file will be created by the first command './bootstrap'.
198+
194199
The remainder of this document tries to provide some instructions for
195200
those looking for a quick-install.
196201

0 commit comments

Comments
 (0)