README.md - Issue 29783566: Issue 6596 - update to work with v8 6.7.288.11

Delta Between Two Patch Sets: README.md

Issue 29783566: Issue 6596 - update to work with v8 6.7.288.11 (Closed) Base URL: https://github.com/adblockplus/libadblockplus@99836840e314b7941fdb51cb2b91f23ca3ee3414

Left Patch Set: Created May 16, 2018, 10:17 a.m.

Right Patch Set: mention the version of V8 Created May 25, 2018, 10:04 a.m.

Left:
Right:

Use n/p to move between diff chunks; N/P to move between comments.

Jump to:

Left: Side by side diff | Download
Right: Side by side diff | Download

LEFT	RIGHT
1 libadblockplus	1 libadblockplus

2 ==============	2 ==============

3	3

4 A C++ library offering the core functionality of Adblock Plus.	4 A C++ library offering the core functionality of Adblock Plus.

5	5

6 Getting/updating the dependencies	6 Getting/updating the dependencies

7 ---------------------------------	7 ---------------------------------

8	8

9 libadblockplus has dependencies that aren't part of this repository. They are	9 libadblockplus has dependencies that aren't part of this repository. They are

10 retrieved and updated during the build process, but you can also manually update	10 retrieved and updated during the build process, but you can also manually update

11 them by running the following:	11 them by running the following:

12	12

13 ./ensure_dependencies.py	13 ./ensure_dependencies.py

14	14

15 Additionally one should provide V8 headers in order to build libadblockplus	15 Additionally one should provide V8 headers in order to build libadblockplus

16 library and V8 prebuilt libraries in order to link a binary (executable, shared	16 library and V8 prebuilt libraries in order to link a binary (executable, shared

17 object/DLL), even libadblockplus tests. For more details see below.	17 object/DLL), even libadblockplus tests. The last time is was tested against V8

	18 6.7.

	19 For more details see below.

18	20

19 Building	21 Building

20 --------	22 --------

21	23

22 ### Supported target platforms and prerequisites	24 ### Supported target platforms and prerequisites

23	25

24 You need a C++14 compatible compiler to build libadblockplus. Below there is	26 You need a C++14 compatible compiler to build libadblockplus. Below there is

25 the list of tested tools.	27 the list of tested tools.

26	28

27 Win32:	29 Win32:

(...skipping 14 matching lines...) Expand all Loading...
42	44

43 If you have a compilation issue with another compiler please [create an issue](h ttps://issues.adblockplus.org/).	45 If you have a compilation issue with another compiler please [create an issue](h ttps://issues.adblockplus.org/).

44	46

45 You also need Python 2.7 and ensure that `python.exe` is in your `PATH`.	47 You also need Python 2.7 and ensure that `python.exe` is in your `PATH`.

46	48

47 ### Unix	49 ### Unix

48	50

49 * Prepare V8 and set environment variables LIBV8_LIB_DIR and LIBV8_INCLUDE_DIR.	51 * Prepare V8 and set environment variables LIBV8_LIB_DIR and LIBV8_INCLUDE_DIR.

50 LIBV8_INCLUDE_DIR should point to the include directory of V8, e.g.	52 LIBV8_INCLUDE_DIR should point to the include directory of V8, e.g.

51 `.../v8/include` and there should be `libv8_monolith.a` in the directory	53 `.../v8/include` and there should be `libv8_monolith.a` in the directory

52 LIBV8_LIB_DIR.	54 LIBV8_LIB_DIR.
hub 2018/05/23 18:27:05 it would be nice to have directions to optionally it would be nice to have directions to optionally get the prebuilts. Or better a script that does what the .travis/prepare-prebuilt-v8.sh script does, but for the local build. anton 2018/05/24 07:41:55 yes, i completely agree. It can be unclear on what Show quoted text On 2018/05/23 18:27:05, hub wrote: > it would be nice to have directions to optionally get the prebuilts. > > Or better a script that does what the .travis/prepare-prebuilt-v8.sh script > does, but for the local build. yes, i completely agree. It can be unclear on what's version of v8 can be used (i'd suggest to write about it in README too), how can it be downloaded/built (required targeting to the same ARCH while building v8 and libadblockplus), etc. Also i believe it could be very useful to provide precompiled v8 just like we do for 'libadblockplus-binaries'. sergei 2018/05/24 08:45:42 That's all right but can we do it in the following Show quoted text On 2018/05/24 07:41:55, anton wrote: > On 2018/05/23 18:27:05, hub wrote: > > it would be nice to have directions to optionally get the prebuilts. > > > > Or better a script that does what the .travis/prepare-prebuilt-v8.sh script > > does, but for the local build. > > yes, i completely agree. > It can be unclear on what's version of v8 can be used (i'd suggest to write > about it in README too), > how can it be downloaded/built (required targeting to the same ARCH while > building v8 and libadblockplus), etc. > Also i believe it could be very useful to provide precompiled v8 just like we do > for 'libadblockplus-binaries'. That's all right but can we do it in the following steps? I deliberately didn't include the version of V8 because now there is no strict connection to a particular version. Here is the issue in that regard https://issues.adblockplus.org/ticket/6694. Regarding the binaries I have filed the issue https://issues.adblockplus.org/ticket/6695. hub 2018/05/24 12:29:51 There is somewhat a connection. I tried to build o Show quoted text On 2018/05/24 08:45:42, sergei wrote: > On 2018/05/24 07:41:55, anton wrote: > > On 2018/05/23 18:27:05, hub wrote: > > > it would be nice to have directions to optionally get the prebuilts. > > > > > > Or better a script that does what the .travis/prepare-prebuilt-v8.sh script > > > does, but for the local build. > > > > yes, i completely agree. > > It can be unclear on what's version of v8 can be used (i'd suggest to write > > about it in README too), > > how can it be downloaded/built (required targeting to the same ARCH while > > building v8 and libadblockplus), etc. > > Also i believe it could be very useful to provide precompiled v8 just like we > do > > for 'libadblockplus-binaries'. > > That's all right but can we do it in the following steps? > > I deliberately didn't include the version of V8 because now there is no strict > connection to a particular version. Here is the issue in that regard > https://issues.adblockplus.org/ticket/6694. > > Regarding the binaries I have filed the issue > https://issues.adblockplus.org/ticket/6695. > There is somewhat a connection. I tried to build on macOS with the v8 provided by Homebrew and it didn't work because it was too old. (just building for macOS) sergei 2018/05/25 10:05:24 I have added the mentioning of the V8 version in t Show quoted text On 2018/05/24 12:29:51, hub wrote: > On 2018/05/24 08:45:42, sergei wrote: > > On 2018/05/24 07:41:55, anton wrote: > > > On 2018/05/23 18:27:05, hub wrote: > > > > it would be nice to have directions to optionally get the prebuilts. > > > > > > > > Or better a script that does what the .travis/prepare-prebuilt-v8.sh > script > > > > does, but for the local build. > > > > > > yes, i completely agree. > > > It can be unclear on what's version of v8 can be used (i'd suggest to write > > > about it in README too), > > > how can it be downloaded/built (required targeting to the same ARCH while > > > building v8 and libadblockplus), etc. > > > Also i believe it could be very useful to provide precompiled v8 just like > we > > do > > > for 'libadblockplus-binaries'. > > > > That's all right but can we do it in the following steps? > > > > I deliberately didn't include the version of V8 because now there is no strict > > connection to a particular version. Here is the issue in that regard > > https://issues.adblockplus.org/ticket/6694. > > > > Regarding the binaries I have filed the issue > > https://issues.adblockplus.org/ticket/6695. > > > > There is somewhat a connection. I tried to build on macOS with the v8 provided > by Homebrew and it didn't work because it was too old. (just building for macOS) I have added the mentioning of the V8 version in the readme file.
53	55

54 Using Make:	56 Using Make:

55	57

56 make	58 make

57	59

58 The default target architecture is the architecture of a host. In order to build for a different architecture pass `TARGET_ARCH` to `make`, e.g. run:	60 The default target architecture is the architecture of a host. In order to build for a different architecture pass `TARGET_ARCH` to `make`, e.g. run:

59	61

60 make TARGET_ARCH=ia32	62 make TARGET_ARCH=ia32

61	63

62 supported values are `ia32` and `x64`.	64 supported values are `ia32` and `x64`.

(...skipping 218 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
281 Linting	283 Linting

282 -------	284 -------

283	285

284 You can lint the code using [ESLint](http://eslint.org).	286 You can lint the code using [ESLint](http://eslint.org).

285	287

286 npm run eslint	288 npm run eslint

287	289

288 In order to set up ESLint and	290 In order to set up ESLint and

289 [configuration eslint-config-eyeo](https://hg.adblockplus.org/codingtools/file/t ip/eslint-config-eyeo) you need [Node.js 7 or higher](https://nodejs.org/) and o nce it is installed please run `npm install` in the repository directory.	291 [configuration eslint-config-eyeo](https://hg.adblockplus.org/codingtools/file/t ip/eslint-config-eyeo) you need [Node.js 7 or higher](https://nodejs.org/) and o nce it is installed please run `npm install` in the repository directory.

290	292

LEFT	RIGHT