README.md - Issue 29345636: Issue 1414 - Document how to build libadblockplus for Android

Side by Side Diff: README.md

Issue 29345636: Issue 1414 - Document how to build libadblockplus for Android (Closed)

Patch Set: Created June 8, 2016, 1:26 p.m.

Left:
Right:

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

Jump to:

View unified diff | Download patch

OLD	NEW
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

(...skipping 40 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
51 `msbuild` command line tool, e.g. run `msbuild /m build\ia32\libadblockplus.sln`	51 `msbuild` command line tool, e.g. run `msbuild /m build\ia32\libadblockplus.sln`

52 from the Visual Studio Developer Command Prompt to create a 32 bit debug build.	52 from the Visual Studio Developer Command Prompt to create a 32 bit debug build.

53	53

54 ### Supported compilers	54 ### Supported compilers

55	55

56 You need a C++11 compatible compiler to build libadblockplus.	56 You need a C++11 compatible compiler to build libadblockplus.

57	57

58 The compilation was tested with the following compilers:	58 The compilation was tested with the following compilers:

59 * g++ 4.8	59 * g++ 4.8

60 * Microsoft Visual Studio 2010, 2012	60 * Microsoft Visual Studio 2010, 2012

61 * clang 3.4 for Android (from android-ndk-r9)	61 * clang 3.4 for Android (from android-ndk-r9, r10c)
	sergei 2016/06/08 15:32:35 It's actually can be quite tricky to find the link It's actually can be quite tricky to find the link to these NDKs because they are not the latest ones and as far as I remember there are no links to them on google's web site. Therefore could you please add links to them at the end of "Supported compilers" section. sergei 2016/06/08 15:32:35 It also makes sense to say may be after the list o It also makes sense to say may be after the list of compilers that we have to use one of these NDK because they contain gcc-4.6 which is required to compile v8. sergei 2016/06/10 11:36:01 Yeah, but unfortunately we cannot achieve it right Show quoted text >> https://codereview.adblockplus.org/29345636/diff/29345637/README.md#newcode61 >> README.md:61: * clang 3.4 for Android (from android-ndk-r9, r10c) >> It's actually can be quite tricky to find the link to these NDKs because they >> are not the latest ones and as far as I remember there are no links to them on >> google's web site. Therefore could you please add links to them at the end of >> "Supported compilers" section. > >That can be useful so i will do it. >However i'd prefer it to be compilable by the latest NDK (r11c) too/instead. Yeah, but unfortunately we cannot achieve it right now because this dependency origins from the version of v8. Currently v8 requires gcc-4.6, the next version (https://issues.adblockplus.org/ticket/1197) requires gcc-4.8. Since #1197 is landed I will look for the next version to update it further to suppor visual stuio 2015. After the latter update I hope it will be possible to use latest NDK, recent versions of v8 require clang and I don't see any concrete version although I have not tried to compile it yet. sergei 2016/06/10 11:36:01 Honestly I personally have not tried to compile it Show quoted text >> https://codereview.adblockplus.org/29345636/diff/29345637/README.md#newcode61 >> README.md:61: * clang 3.4 for Android (from android-ndk-r9, r10c) >> It also makes sense to say may be after the list of compilers that we have to >> use one of these NDK because they contain gcc-4.6 which is required to compile >> v8. > >No problem. BTW, why can't we use any other (more recent) toolchain? F.e. if we >try r11c we can choose gcc-4.9 only. >Does it mean it can't be used? If it can be compiled by some specific toolchain >i believe we should make it more clear to the user. Honestly I personally have not tried to compile it with gcc-4.9 from any of android ndk. It requires at least to dig into v8 gyp and Makefiles and according to previous experience v8 is quite fragile in terms of any modifications, so I would like to avoid it and rather update v8 to a version which does not require old version of compiler. anton 2016/06/14 07:16:46 i've tried to compile with gcc-4.9 from r11c symli Show quoted text On 2016/06/10 11:36:01, sergei wrote: > >> https://codereview.adblockplus.org/29345636/diff/29345637/README.md#newcode61 > >> README.md:61: * clang 3.4 for Android (from android-ndk-r9, r10c) > >> It also makes sense to say may be after the list of compilers that we have to > >> use one of these NDK because they contain gcc-4.6 which is required to > compile > >> v8. > > > >No problem. BTW, why can't we use any other (more recent) toolchain? F.e. if we > >try r11c we can choose gcc-4.9 only. > >Does it mean it can't be used? If it can be compiled by some specific toolchain > >i believe we should make it more clear to the user. > > Honestly I personally have not tried to compile it with gcc-4.9 from any of > android ndk. It requires at least to dig into v8 gyp and Makefiles and according > to previous experience v8 is quite fragile in terms of any modifications, so I > would like to avoid it and rather update v8 to a version which does not require > old version of compiler. i've tried to compile with gcc-4.9 from r11c symlinked to gcc-4.6 and it's not working
62 * clang 3.6 for OS X	62 * clang 3.6 for OS X

63	63

64 If you have a question about another compiler please [create an issue](https://i ssues.adblockplus.org/).	64 If you have a question about another compiler please [create an issue](https://i ssues.adblockplus.org/).

65	65

	66 ### Building for Android
	sergei 2016/06/08 15:32:35 I think it should be before "Supported compilers" I think it should be before "Supported compilers" because there are already "Unix" and "Windows" and this section is very close to them. May be it will be even better to have "Supported compilers" as the first section of "Building". anton 2016/06/14 07:16:46 Done. Show quoted text On 2016/06/08 15:32:35, sergei wrote: > I think it should be before "Supported compilers" because there are already > "Unix" and "Windows" and this section is very close to them. > > May be it will be even better to have "Supported compilers" as the first section > of "Building". Done. anton 2016/06/14 07:16:46 Done. Show quoted text On 2016/06/08 15:32:35, sergei wrote: > I think it should be before "Supported compilers" because there are already > "Unix" and "Windows" and this section is very close to them. > > May be it will be even better to have "Supported compilers" as the first section > of "Building". Done.
	67

	68 First set ANDROID_NDK_ROOT environment variable to your Android NDK directory.
	sergei 2016/06/08 15:32:35 It would be better if you could include an example It would be better if you could include an example. sergei 2016/06/08 15:32:35 There is additional space character between NDK an There is additional space character between NDK and directory. sergei 2016/06/10 11:36:01 Fair enough, albeit I guess nobody is trying to co Show quoted text >> https://codereview.adblockplus.org/29345636/diff/29345637/README.md#newcode68 >> README.md:68: First set ANDROID_NDK_ROOT environment variable to your Android >> NDK directory. >> It would be better if you could include an example. > >This relates to OS so i'm not sure it worth it doing here. Fair enough, albeit I guess nobody is trying to compile libdblockplus for Android on Windows. anton 2016/06/14 07:16:46 Done. Show quoted text On 2016/06/08 15:32:35, sergei wrote: > There is additional space character between NDK and directory. Done. anton 2016/06/14 07:16:46 Not sure it's needed as i assume people trying to Show quoted text On 2016/06/08 15:32:35, sergei wrote: > It would be better if you could include an example. Not sure it's needed as i assume people trying to compile it are a king of advanced users and they (should) know how to do this basic stuff. Also it relates to OS so i believe it's out of scope of this readme
	69

	70 To build for x86 arch run:

	71

	72 make android_x86

	73

	74 To build for arm arch run:

	75

	76 make android_arm

	77

66 Usage	78 Usage

67 -----	79 -----

68	80

69 You can use libadblockplus to build an ad blocker. Or, strictly speaking, a web	81 You can use libadblockplus to build an ad blocker. Or, strictly speaking, a web

70 content filter. Just like Adblock Plus, it can detect resources that should be	82 content filter. Just like Adblock Plus, it can detect resources that should be

71 blocked based on their URL and context information, and generate CSS selectors	83 blocked based on their URL and context information, and generate CSS selectors

72 to hide DOM elements.	84 to hide DOM elements.

73	85

74 The basic usage is explained below, see the	86 The basic usage is explained below, see the

75 [API documentation](https://adblockplus.org/docs/libadblockplus) for more	87 [API documentation](https://adblockplus.org/docs/libadblockplus) for more

(...skipping 133 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
209	221

210 ### Unix	222 ### Unix

211	223

212 The shell is automatically built by `make`, you can run it as follows:	224 The shell is automatically built by `make`, you can run it as follows:

213	225

214 build/out/abpshell	226 build/out/abpshell

215	227

216 ### Windows	228 ### Windows

217	229

218 Just run the project abpshell.	230 Just run the project abpshell.

OLD	NEW

« no previous file with comments | « no previous file | no next file » | no next file with comments »