1753127 - Import the NSPR doc from MDN

Status: RESOLVED FIXED

(NSPR :: NSPR, task)

Comment 1

[Sylvestre Ledru [:Sylvestre]]

Attachment: Bug 1753127 - NSPR doc: initial import UPGRADE_NSS_RELEASE r?bbeurdouche,kaie

Comment 2

[Sylvestre Ledru [:Sylvestre]]

Attachment: Bug 1753127 - NSPR doc: Remove some old docs UPGRADE_NSS_RELEASE r?bbeurdouche,kaie

Depends on D137588

Comment 3

[Sylvestre Ledru [:Sylvestre]]

Attachment: Bug 1753127 - NSPR doc: fix many different issues UPGRADE_NSS_RELEASE r?bbeurdouche,kaie

Depends on D137589

Comment 4

[Kai Engert (:KaiE:)]

Unfortunately the MDN docs are incomplete, they are missing details. I guess the problem was introduced a long time in the past, when an import from www to MDN was made.

For example, look at file nspr_types in your patch. At the bottom, in section "Status Type for Return Values", it simply says "PRStatus".

But the docs here include more information: https://www-archive.mozilla.org/projects/nspr/reference/html/prtyp
You will see information missing for each section on that page.

Comment 5

[Kai Engert (:KaiE:)]

Thanks to bkochendorfer
who told me where to find the raw www files:
https://github.com/mozilla-it/www-archive.mozilla.org/tree/master/projects/nspr

Comment 6

[Sylvestre Ledru [:Sylvestre]]

Well, to be honest, I have no intention to improve the doc itself.
I just want them to be available online which has not been the case for sometime.

But looking a bit deeper, I don't see what is missing on the imports.

For example, look at file nspr_types in your patch. At the bottom, in section "Status Type for Return Values", it simply says "PRStatus".

I think during the MDN import, the content has been split into smaller page.
For PRStatus, it is pointing to the page:
http://gecko-docs.mozilla.org-l1.s3-website.us-west-2.amazonaws.com/main/1f997d84-83bf-11ec-bf1c-0242ac110004/security/nss/nspr/reference/prstatus.html

Note that the original URL doesn't have more content:
https://github.com/mozilla-it/www-archive.mozilla.org/blob/ad04f29f02b91122b33b85ddfcd544db187cf531/projects/nspr/reference/html/Prtyp.html#L406-L417

Comment 7

[Sylvestre Ledru [:Sylvestre]]

Attachment: Bug 1753127 - NSPR doc: fix some links in the various part of the doc UPGRADE_NSS_RELEASE r?bbeurdouche,kaie

Depends on D137590

Comment 8

[Kai Engert (:KaiE:)]

(In reply to Sylvestre Ledru [:Sylvestre] from comment #6)

Well, to be honest, I have no intention to improve the doc itself.
I just want them to be available online which has not been the case for sometime.

That's fine. My point is, the MDN docs are incomplete, and I'd prefer that we rather import the documentation from www-archive.

But looking a bit deeper, I don't see what is missing on the imports.

This is your full import:
https://d2mfgivbiy2fiw.cloudfront.net/file/data/f3tiyglgas67tkloxo2b/PHID-FILE-caorl5jyazygw4uyuv3g/D137588.diff

That doesn't contain the text "Use PRPackedBool within structures where bit fields" which I found on this page:
https://www-archive.mozilla.org/projects/nspr/reference/html/prtyp

Comment 9

[Sylvestre Ledru [:Sylvestre]]

Attachment: Bug 1753127 - NSPR doc: Add some missing content back UPGRADE_NSS_RELEASE r?kaie

Depends on D137607

Comment 10

[Sylvestre Ledru [:Sylvestre]]

Attachment: Bug 1753127 - NSPR doc: move the doc into docs/nspr UPGRADE_NSS_RELEASE r?kaie

Depends on D137611

Comment 11

[Sylvestre Ledru [:Sylvestre]]

Attachment: Bug 1753127 - NSPR doc: fix the typos, warnings and nbsp; r?kaie

Comment 12

[Kai Engert (:KaiE:)]

For the record:

Normally, the keywords UPGRADE_NSS_RELEASE and UPGRADE_NSPR_RELEASE are allowed only when comitting official upstream releases.

We allow these changes, because they are temporary, to simplify Sylvestre's work.

All files that are added to the security/nss and nsprpub directories (temporarily) are suposed to be moved to a different place as part of the patches in this bug.

After all patches were landed, we must verify that no (new or changed) files remain, and that using the NSS/NSPR update scripts will create the exact same state of the directories. If a difference is shown, and the differences are supposed to be kept, follow-up work will be required.

Comment 13

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/ca5af776e499
NSPR doc: initial import UPGRADE_NSS_RELEASE r=bbeurdouche

Comment 14

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/0be9674635b7
NSPR doc: Remove some old docs UPGRADE_NSS_RELEASE r=bbeurdouche
https://hg.mozilla.org/integration/autoland/rev/3f1b085c285c
NSPR doc: fix many different issues UPGRADE_NSS_RELEASE r=bbeurdouche
https://hg.mozilla.org/integration/autoland/rev/8cd0d45e0306
NSPR doc: fix some links in the various part of the doc UPGRADE_NSS_RELEASE r=bbeurdouche
https://hg.mozilla.org/integration/autoland/rev/291e7044fbb6
NSPR doc: Add some missing content back UPGRADE_NSS_RELEASE r=kaie,bbeurdouche
https://hg.mozilla.org/integration/autoland/rev/2ef5b56d94f8
NSPR doc: move the doc into docs/nspr UPGRADE_NSS_RELEASE r=kaie,bbeurdouche
https://hg.mozilla.org/integration/autoland/rev/a27f2f698323
NSPR doc: fix the typos, warnings and nbsp; r=kaie

Comment 15

[Cristina Cozmuta (:CrissCozmuta)]

https://hg.mozilla.org/mozilla-central/rev/ca5af776e499
https://hg.mozilla.org/mozilla-central/rev/0be9674635b7
https://hg.mozilla.org/mozilla-central/rev/3f1b085c285c
https://hg.mozilla.org/mozilla-central/rev/8cd0d45e0306
https://hg.mozilla.org/mozilla-central/rev/291e7044fbb6
https://hg.mozilla.org/mozilla-central/rev/2ef5b56d94f8
https://hg.mozilla.org/mozilla-central/rev/a27f2f698323

Comment 16

[Sylvestre Ledru [:Sylvestre]]

Attachment: Bug 1753127 - NSS doc: fix the link to NSPR r?bbeurdouche

Note: these links won't work for local doc build of NSS.
They are designed for firefox source tree:
https://firefox-source-docs.mozilla.org/security/nss/

Comment 17

[Sylvestre Ledru [:Sylvestre]]

Attachment: Bug 1753127 - NSS doc: fix a typo r?bbeurdouche

Comment 18

[Sylvestre Ledru [:Sylvestre]]

Attachment: Bug 1753127 - NSPR doc: fix some links + cosmetic changes r?kaie

Comment 19

[Kai Engert (:KaiE:)]

I'm attaching with additional docs that I found on https://github.com/mozilla-it/www-archive.mozilla.org and https://github.com/mdn/archived-content

Included are two training documents, that were originally .ppt files.

Comment 20

[Kai Engert (:KaiE:)]

Attachment: Bug 1753127 - Additional NSPR docs from www and MDN archives. r=sylvestre

Comment 21

[Kai Engert (:KaiE:)]

What happens to files that aren't linked? They cannot be opened through https://firefox-source-docs.mozilla.org/nspr/ right?

This old page here has a table "technical notes". It would be good to copy that and link the various documents that we have in tree.
www-archive.mozilla.org/projects/nspr/index.html

Comment 22

[Sylvestre Ledru [:Sylvestre]]

Attachment: Bug 1753127 - NSPR doc: add a listing page r?kaie

Comment 23

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/42ba20e22c90
NSPR doc: add a listing page r=kaie DONTBUILD

Comment 24

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/1ec37fdbe79a
NSPR doc: fix some links + cosmetic changes r=kaie

Comment 25

[Marian-Vasile Laza]

https://hg.mozilla.org/mozilla-central/rev/42ba20e22c90
https://hg.mozilla.org/mozilla-central/rev/1ec37fdbe79a

Comment 26

[Sylvestre Ledru [:Sylvestre]]

Attachment: Bug 1753127 - NSPR doc: Fix warnings and links r?kaie

Depends on D137751

Comment 27

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/4c94a2f92c86
Additional NSPR docs from www and MDN archives. r=sylvestre DONTBUILD
https://hg.mozilla.org/integration/autoland/rev/187da20ce174
NSPR doc: Fix warnings and links r=kaie DONTBUILD

Comment 28

[Iulian Moraru]

https://hg.mozilla.org/mozilla-central/rev/4c94a2f92c86
https://hg.mozilla.org/mozilla-central/rev/187da20ce174