[PR PATCH] ghc: allow building with current Sphinx

[PR PATCH] ghc: allow building with current Sphinx

[chexum]

[-- Attachment #1: Type: text/plain, Size: 1922 bytes --]

There is a new pull request by chexum against master on the void-packages repository

https://github.com/chexum/void-packages ghc-884
https://github.com/void-linux/void-packages/pull/31898

ghc: allow building with current Sphinx
./srcpkg build ghc fails with current tools:

"inplace/bin/ghc-stage1" [...] /build/cbits/longlong.p_o
Running Sphinx v4.0.2

Configuration error:
There is a syntax error in your configuration file: (unicode error) 'unicodeescape' codec can't decode bytes in position 1-2: truncated \uXXXX escape (conf.py, line 87)

...
make: *** [Makefile:128: all] Error 2

According to https://gitlab.haskell.org/ghc/ghc/-/issues/19962

>> This fix is to use raw strings, as already done in master:
>> https://gitlab.haskell.org/ghc/ghc/-/blob/master/docs/users_guide/conf.py#L96

Sanitized from commit (only small parts apply)
https://gitlab.haskell.org/ghc/ghc/-/commit/83407ffc7acc00cc025b9f6ed063add9ab9f9bcc

#### General
- [ ] This is a new package and it conforms to the [quality requirements](https://github.com/void-linux/void-packages/blob/master/Manual.md#quality-requirements)

#### Have the results of the proposed changes been tested?
- [ ] I use the packages affected by the proposed changes on a regular basis and confirm this PR works for me
- [x] I generally don't use the affected packages but briefly tested this PR

[skip CI] build might take over 3 hours with a single CPU - local build/pkg tested

#### Does it build and run successfully? 
(Please choose at least one native build and, if supported, at least one cross build. More are better.)
- [x] I built this PR locally for my native architecture, (x86_64)
- [ ] I built this PR locally for these architectures (if supported. mark crossbuilds):
  - [ ] aarch64-musl
  - [ ] armv7l
  - [ ] armv6l-musl


A patch file from https://github.com/void-linux/void-packages/pull/31898.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-ghc-884-31898.patch --]
[-- Type: text/x-diff, Size: 2357 bytes --]

From f427a699740524c92f1544bedd7cb8346515d073 Mon Sep 17 00:00:00 2001
From: J Farkas <chexum+git@gmail.com>
Date: Sat, 10 Jul 2021 19:28:54 +0000
Subject: [PATCH] ghc: allow building with current Sphinx

./srcpkg build ghc fails with current tools:

"inplace/bin/ghc-stage1" [...] /build/cbits/longlong.p_o
Running Sphinx v4.0.2

Configuration error:
There is a syntax error in your configuration file: (unicode error) 'unicodeescape' codec can't decode bytes in position 1-2: truncated \uXXXX escape (conf.py, line 87)

...
make: *** [Makefile:128: all] Error 2

According to https://gitlab.haskell.org/ghc/ghc/-/issues/19962

>> This fix is to use raw strings, as already done in master:
>> https://gitlab.haskell.org/ghc/ghc/-/blob/master/docs/users_guide/conf.py#L96

Sanitized from commit (only small parts apply)
https://gitlab.haskell.org/ghc/ghc/-/commit/83407ffc7acc00cc025b9f6ed063add9ab9f9bcc
---
 srcpkgs/ghc/patches/sphinx-unicode.patch | 17 +++++++++++++++++
 srcpkgs/ghc/template                     |  2 +-
 2 files changed, 18 insertions(+), 1 deletion(-)
 create mode 100644 srcpkgs/ghc/patches/sphinx-unicode.patch

diff --git a/srcpkgs/ghc/patches/sphinx-unicode.patch b/srcpkgs/ghc/patches/sphinx-unicode.patch
new file mode 100644
index 000000000000..0286b9c2bd31
--- /dev/null
+++ b/srcpkgs/ghc/patches/sphinx-unicode.patch
@@ -0,0 +1,17 @@
+diff -rpU2 ghc-8.8.4-orig/docs/users_guide/conf.py ghc-8.8.4/docs/users_guide/conf.py
+--- ghc-8.8.4-orig/docs/users_guide/conf.py	2020-07-08 16:43:03.000000000 +0000
++++ ghc-8.8.4/docs/users_guide/conf.py	2021-07-10 20:25:33.536928487 +0000
+@@ -78,5 +78,5 @@ latex_elements = {
+     'inputenc': '',
+     'utf8extra': '',
+-    'preamble': '''
++    'preamble': r'''
+ \usepackage{fontspec}
+ \usepackage{makeidx}
+@@ -84,5 +84,5 @@ latex_elements = {
+ \setromanfont{DejaVu Serif}
+ \setmonofont{DejaVu Sans Mono}
+-\setlength{\\tymin}{45pt}
++\setlength{\tymin}{45pt}
+ ''',
+ }
diff --git a/srcpkgs/ghc/template b/srcpkgs/ghc/template
index 082c56f70358..90ce760a09d6 100644
--- a/srcpkgs/ghc/template
+++ b/srcpkgs/ghc/template
@@ -2,7 +2,7 @@
 pkgname=ghc
 # Keep this synchronized with http://www.stackage.org/lts
 version=8.8.4
-revision=2
+revision=3
 wrksrc="ghc-${version%[!0-9]}"
 build_style=gnu-configure
 hostmakedepends="automake docbook-xsl ghc-bin libxslt libnuma-devel

Re: ghc: allow building with current Sphinx

[chexum]

[-- Attachment #1: Type: text/plain, Size: 823 bytes --]

New comment by chexum on void-packages repository

https://github.com/void-linux/void-packages/pull/31898#issuecomment-877788410

Comment:
By the way, it seems the build checks are failing because there is no check target:

2021-07-10T22:39:46.1203634Z ===--- building final phase
2021-07-10T22:39:46.1204570Z make --no-print-directory -f ghc.mk phase=final check
2021-07-10T22:39:49.0161381Z make[1]: *** No rule to make target 'check'.  Stop.
2021-07-10T22:39:49.0186932Z make: *** [Makefile:128: check] Error 2
2021-07-10T22:39:49.0191464Z => ERROR: ghc-8.8.4_3: do_check: '${make_cmd} ${make_check_args} ${make_check_target}' exited with 2
2021-07-10T22:39:49.0193972Z => ERROR:   in do_check() at common/build-style/gnu-configure.sh:33
2021-07-10T22:39:49.0462777Z ##[error]Process completed with exit code 1.

Re: [PR REVIEW] ghc: allow building with current Sphinx

[ericonr]

[-- Attachment #1: Type: text/plain, Size: 214 bytes --]

New review comment by ericonr on void-packages repository

https://github.com/void-linux/void-packages/pull/31898#discussion_r671602036

Comment:
If this is only to fix the build, I don't think we need to revbump.

Re: [PR REVIEW] ghc: allow building with current Sphinx

[chexum]

[-- Attachment #1: Type: text/plain, Size: 311 bytes --]

New review comment by chexum on void-packages repository

https://github.com/void-linux/void-packages/pull/31898#discussion_r671636277

Comment:
Fair enough - anyone having a previously  compiled version is not likely interested to have a new revision forced onto them.  Would I need to push an updated commit?

Re: [PR REVIEW] ghc: allow building with current Sphinx

[ericonr]

[-- Attachment #1: Type: text/plain, Size: 159 bytes --]

New review comment by ericonr on void-packages repository

https://github.com/void-linux/void-packages/pull/31898#discussion_r671898185

Comment:
Yes, please.

Re: [PR PATCH] [Updated] ghc: allow building with current Sphinx

[chexum]

[-- Attachment #1: Type: text/plain, Size: 1927 bytes --]

There is an updated pull request by chexum against master on the void-packages repository

https://github.com/chexum/void-packages ghc-884
https://github.com/void-linux/void-packages/pull/31898

ghc: allow building with current Sphinx
./srcpkg build ghc fails with current tools:

"inplace/bin/ghc-stage1" [...] /build/cbits/longlong.p_o
Running Sphinx v4.0.2

Configuration error:
There is a syntax error in your configuration file: (unicode error) 'unicodeescape' codec can't decode bytes in position 1-2: truncated \uXXXX escape (conf.py, line 87)

...
make: *** [Makefile:128: all] Error 2

According to https://gitlab.haskell.org/ghc/ghc/-/issues/19962

>> This fix is to use raw strings, as already done in master:
>> https://gitlab.haskell.org/ghc/ghc/-/blob/master/docs/users_guide/conf.py#L96

Sanitized from commit (only small parts apply)
https://gitlab.haskell.org/ghc/ghc/-/commit/83407ffc7acc00cc025b9f6ed063add9ab9f9bcc

#### General
- [ ] This is a new package and it conforms to the [quality requirements](https://github.com/void-linux/void-packages/blob/master/Manual.md#quality-requirements)

#### Have the results of the proposed changes been tested?
- [ ] I use the packages affected by the proposed changes on a regular basis and confirm this PR works for me
- [x] I generally don't use the affected packages but briefly tested this PR

[skip CI] build might take over 3 hours with a single CPU - local build/pkg tested

#### Does it build and run successfully? 
(Please choose at least one native build and, if supported, at least one cross build. More are better.)
- [x] I built this PR locally for my native architecture, (x86_64)
- [ ] I built this PR locally for these architectures (if supported. mark crossbuilds):
  - [ ] aarch64-musl
  - [ ] armv7l
  - [ ] armv6l-musl


A patch file from https://github.com/void-linux/void-packages/pull/31898.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-ghc-884-31898.patch --]
[-- Type: text/x-diff, Size: 1885 bytes --]

From 383f8dc461d2b693cf1f7de4479889e5fbb4a8ce Mon Sep 17 00:00:00 2001
From: J Farkas <chexum+git@gmail.com>
Date: Sat, 10 Jul 2021 19:28:54 +0000
Subject: [PATCH] ghc: allow building with current Sphinx

./srcpkg build ghc fails with current tools:

"inplace/bin/ghc-stage1" [...] /build/cbits/longlong.p_o
Running Sphinx v4.0.2

Configuration error:
There is a syntax error in your configuration file: (unicode error) 'unicodeescape' codec can't decode bytes in position 1-2: truncated \uXXXX escape (conf.py, line 87)

...
make: *** [Makefile:128: all] Error 2

According to https://gitlab.haskell.org/ghc/ghc/-/issues/19962

>> This fix is to use raw strings, as already done in master:
>> https://gitlab.haskell.org/ghc/ghc/-/blob/master/docs/users_guide/conf.py#L96

Sanitized from commit (only small parts apply)
https://gitlab.haskell.org/ghc/ghc/-/commit/83407ffc7acc00cc025b9f6ed063add9ab9f9bcc
---
 srcpkgs/ghc/patches/sphinx-unicode.patch | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 srcpkgs/ghc/patches/sphinx-unicode.patch

diff --git a/srcpkgs/ghc/patches/sphinx-unicode.patch b/srcpkgs/ghc/patches/sphinx-unicode.patch
new file mode 100644
index 000000000000..0286b9c2bd31
--- /dev/null
+++ b/srcpkgs/ghc/patches/sphinx-unicode.patch
@@ -0,0 +1,17 @@
+diff -rpU2 ghc-8.8.4-orig/docs/users_guide/conf.py ghc-8.8.4/docs/users_guide/conf.py
+--- ghc-8.8.4-orig/docs/users_guide/conf.py	2020-07-08 16:43:03.000000000 +0000
++++ ghc-8.8.4/docs/users_guide/conf.py	2021-07-10 20:25:33.536928487 +0000
+@@ -78,5 +78,5 @@ latex_elements = {
+     'inputenc': '',
+     'utf8extra': '',
+-    'preamble': '''
++    'preamble': r'''
+ \usepackage{fontspec}
+ \usepackage{makeidx}
+@@ -84,5 +84,5 @@ latex_elements = {
+ \setromanfont{DejaVu Serif}
+ \setmonofont{DejaVu Sans Mono}
+-\setlength{\\tymin}{45pt}
++\setlength{\tymin}{45pt}
+ ''',
+ }

Re: ghc: allow building with current Sphinx

[ericonr]

[-- Attachment #1: Type: text/plain, Size: 159 bytes --]

New comment by ericonr on void-packages repository

https://github.com/void-linux/void-packages/pull/31898#issuecomment-883660955

Comment:
Nice find, thanks!

Re: [PR PATCH] [Merged]: ghc: allow building with current Sphinx

[ericonr]

[-- Attachment #1: Type: text/plain, Size: 1773 bytes --]

There's a merged pull request on the void-packages repository

ghc: allow building with current Sphinx
https://github.com/void-linux/void-packages/pull/31898

Description:
./srcpkg build ghc fails with current tools:

"inplace/bin/ghc-stage1" [...] /build/cbits/longlong.p_o
Running Sphinx v4.0.2

Configuration error:
There is a syntax error in your configuration file: (unicode error) 'unicodeescape' codec can't decode bytes in position 1-2: truncated \uXXXX escape (conf.py, line 87)

...
make: *** [Makefile:128: all] Error 2

According to https://gitlab.haskell.org/ghc/ghc/-/issues/19962

>> This fix is to use raw strings, as already done in master:
>> https://gitlab.haskell.org/ghc/ghc/-/blob/master/docs/users_guide/conf.py#L96

Sanitized from commit (only small parts apply)
https://gitlab.haskell.org/ghc/ghc/-/commit/83407ffc7acc00cc025b9f6ed063add9ab9f9bcc

#### General
- [ ] This is a new package and it conforms to the [quality requirements](https://github.com/void-linux/void-packages/blob/master/Manual.md#quality-requirements)

#### Have the results of the proposed changes been tested?
- [ ] I use the packages affected by the proposed changes on a regular basis and confirm this PR works for me
- [x] I generally don't use the affected packages but briefly tested this PR

[skip CI] build might take over 3 hours with a single CPU - local build/pkg tested

#### Does it build and run successfully? 
(Please choose at least one native build and, if supported, at least one cross build. More are better.)
- [x] I built this PR locally for my native architecture, (x86_64)
- [ ] I built this PR locally for these architectures (if supported. mark crossbuilds):
  - [ ] aarch64-musl
  - [ ] armv7l
  - [ ] armv6l-musl