Skip to content

Remove internals2 book #152

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.

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

Closed
wants to merge 1 commit into from
Closed

Conversation

cmb69
Copy link
Member

@cmb69 cmb69 commented Oct 9, 2020

The "Hacker's guide" is grossly outdated (it is about ZendEngine 2;
some stuff even about ZE1, although ZE4 is comming), and nobody is
working on it for years. Therefore we remove this part of the manual;
users are better off reading external resources, such as
http://www.phpinternalsbook.com/.


This is only the removal for now; we should actually add some information about external resources (some form of curated link list), but where? We should probably also remove the low-level parts of the Garbage Collection section.

We should also not forget to delete the respective user notes from the manual, and to close doc bug reports regarding internals documentation.

This PR requires the following patch to doc-base:

Index: manual.xml.in
===================================================================
--- manual.xml.in	(revision 350824)
+++ manual.xml.in	(working copy)
@@ -440,26 +440,6 @@
   </set>
  </set>
 
- <book xml:id="internals2">
-  <title>&Internals2;</title>
-  &internals2.intro;
-  &internals2.memory.index;
-  &internals2.variables.index;
-  &internals2.funcs.index;
-  &internals2.objects.index;
-  &internals2.resources.index;
-  &internals2.ini.index;
-  &internals2.streams.index;
-  &internals2.counter;
-  &internals2.buildsys.index;
-  &internals2.structure.index;
-  &internals2.pdo.index;
-  &internals2.faq.index;
-  &internals2.apiref.index;
-  &internals2.opcodes;
-  &internals2.ze1.index;
- </book>
-
  <book xml:id="faq">
   <title>&FAQ;</title>
   <titleabbrev>&FAQabbrev;</titleabbrev>

The "Hacker's guide" is grossly outdated (it is about ZendEngine 2;
some stuff even about ZE1, although ZE4 is comming), and nobody is
working on it for years.  Therefore we remove this part of the manual;
users are better off reading external resources, such as
<http://www.phpinternalsbook.com/>.
@cmb69
Copy link
Member Author

cmb69 commented Oct 11, 2020

PR to move the PDO Driver How-To to phpinternalsbook: phpinternalsbook/PHP-Internals-Book#97

@afilina
Copy link
Contributor

afilina commented Jan 8, 2021

Is there a TODO entry for the follow-up tasks on bugs.php.net? Of so, then I believe this is mergeable (after rebase).
I would recommend updating doc-base first and merge this one afterwards.

@cmb69
Copy link
Member Author

cmb69 commented Jan 10, 2021

Thanks for the reminder! It's overdue to remove this.

I have removed all user notes; roughly a third of them were regarding the ZE1 docs; another third were actually about userland stuff (e.g. there have been several user notes regarding the instanceof operator on the INSTANCEOF OPcode page).

Also, I'd like to note that I submitted a draft PR regarding internal stream documentation a while ago: phpinternalsbook/PHP-Internals-Book#98

And I have no filed https://bugs.php.net/bug.php?id=80612 to not forget about adding info about external resources regarding this topic.

php-pulls pushed a commit to php/doc-base that referenced this pull request Jan 10, 2021
@php-pulls php-pulls closed this in a3bb15d Jan 10, 2021
@cmb69 cmb69 deleted the cmb/remove-internals2 branch January 10, 2021 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants