8000 Links to Boost 1.70 and 1.71 documentation still broken · Issue #351 · boostorg/gil · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Links to Boost 1.70 and 1.71 documentation still broken #351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
mloskot opened this issue Jul 23, 2019 · 14 comments
Closed

Links to Boost 1.70 and 1.71 documentation still broken #351

mloskot opened this issue Jul 23, 2019 · 14 comments
Assignees
@mloskot @stefanseefeld
Labels
cat/bug But reports and bug fixes cat/documentation
Milestone
Boost 1.72

Comments

@mloskot
Copy link
Member
mloskot commented Jul 23, 2019 •
edited
Loading

Reminder about the broken links I reported here https://lists.boost.org/Archives/boost/2019/04/245985.php. Shortly, https://www.boost.org/doc/libs/1_70_0/libs/gil/ yields HTTP 404.

I've fiddled with the URL to figure out if the redirects needs an update, but it seems there are no GIL documentation files on the server. In fact, there are no docs in the Boost 1.70 source distribution archive:

image

A redirect or upload of the missing docs to the server should be arranged to fix it ASAP!

References
@mloskot mloskot added cat/bug But reports and bug fixes cat/documentation labels Jul 23, 2019
@mloskot
Copy link
Member Author
mloskot commented Jul 24, 2019 •
edited
Loading

@stefanseefeld Do you know answer to Glen's question below?
I fear Boost 1.71 will ship with broken docs for GIL. Second time in row does not sound like a good thing.

Screenshot_20190724-223226

@stefanseefeld
Copy link
Member

I can certainly make sure our process to update http://boostorg.github.io/gil is working correctly (both for the master as well as the develop branches). I'm not sure what is required to generate the monolithic boost documentation, beyond the above. Is that formally documented anywhere ? I know I have struggled to find the answer to that before...

@mloskot
Copy link
Member Author
mloskot commented Jul 24, 2019

I'm not sure what is required to generate the monolithic boost documentation, beyond the above.
Is that formally documented anywhere ?

Trying to learn it
https://lists.boost.org/Archives/boost/2019/07/246658.php

Meanwhile, @mjcaisse is also looking at this.

@mloskot
Copy link
Member Author
mloskot commented Aug 9, 2019

Posted GIL docs missing again (was: [release] Boost 1.71.0 Release Candidate 1)

@mloskot mloskot changed the title Links to Boost 1.70 documentation still broken Links to Boost 1.70 and 1.71 documentation still broken Aug 27, 2019
@mloskot
Copy link
Member Author
mloskot commented Sep 6, 2019 •
edited
Loading

On Slack, @glenfe @mjcaisse were discussing GIL docs missing from the releases. Below I'm copying my response:

I think I managed to pin point what was the problem in https://lists.boost.org/Archives/boost/2019/08/246764.php

Shortly, the missing docs for GIL master are due to this top-level https://github.com/boostorg/gil/blob/master/Jamfile which @pdimov rightly blames for the requires-s.
Apparently, these checks fail for the docs building environment.

This has been addressed by this commit removing the top-level Jamfile in 4ed7701

Unfortunately, this commit is not yet in master because develop was having number of changes not ready for release with 1.70/1.71.

I realised that a week before the release and I did not know what to do.
Would cherry-picking the 4ed7701 commit do the job or only true merges are kosher?
I could not get in touch with @stefanseefeld to decide what shall we do (summer holidays etc.)

@stefanseefeld We need to solve it ASAP. @pdimov suggests we should cherry-pick the fix from develop to master.

@stefanseefeld
Copy link
Member

@mloskot , I'm fine with that fix. (I would prefer if there was some sort of "test" (even if it's not automated) that we can use to check whether a given revision exhibits the problem or not, so as to have a measure of success without actually committing to master...)

@mloskot
Copy link
Member Author
mloskot commented Sep 18, 2019 •
edited
Loading

@stefanseefeld

I would prefer if there was some sort of "test" that we can use to check whether a given revision exhibits the problem or not

Here is one possible:

  1. Get Linux environment
  2. Install GCC 4.8 so gcc --version prints 4.8. I hope I correctly remember this is the default toolset used on the docs building environment. Let's see if it is confirmed in this thread: Details of environment building release docs and website.
  3. cd libs/gil && git checkout master && git pull origin master && cd ../..
  4. b2 libs/gil/doc

Locally on Ubuntu 18.04, I have verified that, in the current master branch, our libs/gil/Jamfile with its all C++ checks, is the showstopper:

image

@stefanseefeld
Copy link
Member

@mloskot , what is the above output telling me ? I'v been running this kind of process many times, so I'm rather familiar with it. The piece I'm missing is a check that tells me specifically that the documentation build (as it is performed during the overall boost release website update) is broken. So other than @pdimov telling us what needs to be fixed, is there a check that can be run that yields the same information ?

@mloskot
Copy link
Member Author
mloskot commented Sep 18, 2019 •
edited
Loading

@stefanseefeld

what is the above output telling me ?

It tells that this https://github.com/boostorg/gil/blob/master/Jamfile will fail our docs to build on the Boost's global docs building environment where presumably b2 picks GCC 4.8 (or possibly 4.9 too) by default.

The piece I'm missing is a check that tells me specifically that the documentation build (as it is performed during the overall boost release website update) is broken.

The test above shows exactly that!

In other words, it shows this:
if Boost uses Ubuntu 14.04 (or possibly 16.04 too), then it will fail to build docs for our current master branch.

Shortly, b2 skips building docs for GIL from current master due to the C++ checks from our Jamfile not being satisfied.

@mloskot
Copy link
Member Author
mloskot commented Sep 26, 2019 •
edited
Loading

On Gitter, we've further clarified the comments above with @stefanseefeld , see September 18, 2019 2:54 PM chat.

I assume all is clear now.
I'm going to cherry-pick the fixing commits from develop and push it to master:

  • 4ed7701 (excluding test/core/color_base present in develop only)
  • 628bfc2

@mloskot mloskot mentioned this issue Sep 26, 2019
Merged
2 tasks
mloskot added a commit that referenced this issue Sep 30, 2019
@mloskot
Merge pull request #394 from mloskot/ml/emergency-master-fix-for-docs…
1d9fe2c 
…-build-bug-351

Emergency cherry-picks to fix documentation build in master

Fixes #351
@mloskot
Copy link
Member Author
mloskot commented Sep 30, 2019

I assume this one has been fixed by 1d9fe2c
Otherwise, it should be re-opened.

@mloskot mloskot closed this as completed Sep 30, 2019
@mloskot mloskot added this to the Boost 1.72 milestone Sep 30, 2019
@glenfe
Copy link
Member
glenfe commented Sep 30, 2019

Looks like 1.72 will have GIL documentation: https://www.boost.org/doc/libs/master/libs/gil/doc/html/index.html

@stefanseefeld
Copy link
Member

Great to hear. Thanks @mloskot for pushing this through !

@mloskot
Copy link
Member Author
mloskot commented Sep 30, 2019

Thanks @glenfe for the very good news!

@mloskot mloskot modified the milestones: Boost 1.72, Boost 1.72+ Oct 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mloskot mloskot

@stefanseefeld stefanseefeld

Labels
cat/bug But reports and bug fixes cat/documentation
Projects
None yet
3896
Milestone
Boost 1.72
Development

No branches or pull requests
3 participants
@mloskot @glenfe @stefanseefeld
0