Contributor's Guide — Section Changes in 2.24
|
This page highlights Sections of the Lilypond Contributor's Guide that are
new in 2.24.0 or changed since 2.22.2.
Of course, there is a separate official description of the
Changes in 2.24
focusing on new features, but documentation can also include new explanations.
The idea here is that you will gradually learn what's new through your usual browsing
if you see which sections have changed in areas that interest you.
◀ Start your browsing on the left.
This is the usual table of contents except that it is fully expanded to show the hierarchy of all sections.
Colors distinguish the New Sections and the Changed Sections.
Font sizes show how big the changes are.
Links lead to the official documentation in another tab.
The panel below shows how many lines of Texinfo source were added, changed or deleted
in each section that was modified.
Sections with the most modifications are listed first.
It also uses your browsing history to indicate which new/changed sections you still haven't visited,
so you can use it as a reading checklist.
▼
| |
See below for Details, Caveats,
Tips and Old/Obsolete Sections
|
| Track Your Progress |
|---|
| These New/Changed sections change color once you've visited them. |
|---|
| Lines | (add,chg,del) | Parent > Section |
|---|
| 1. | 277 | NEW | 10. Programming work > 10.16 Garbage collection for dummies |
| 2. | 235 | (113,74,48) | 11. Release work > 11.2 Release checklist |
| 3. | 139 | (53,46,40) | 7. LSR work > 7.5 LSR to Git |
| 4. | 123 | NEW | 8. Issues > 8.2 Triaging bugs |
| 5. | 100 | NEW | 7. LSR work > 7.4 The makelsr.pl script |
| 6. | 99 | NEW | 10.7 Debugging LilyPond > 10.7.4 Debugging scoring algorithms |
| 7. | 98 | (0,47,51) | 5.9.2 Documentation translation details > Files to be translated |
| 8. | 92 | (46,31,15) | 4.2 Requirements > 4.2.3 Requirements for building documentation |
| 9. | 88 | (0,6,82) | 3. Working with source code > 3.5 Commit access |
| 10. | 81 | (29,46,6) | 7. LSR work > 7.2 Adding and editing snippets |
| 11. | 77 | (24,24,29) | 10.5 Code style > 10.5.3 Code formatting |
| 12. | 73 | (9,30,34) | 4.2.2 Requirements for compiling LilyPond > Other |
| 13. | 62 | (0,0,62) | 9. Regression tests > 9.2 Precompiled regression tests |
| 14. | 61 | (60,1,0) | 8. Issues > 8.1 Introduction to issues |
| 15. | 59 | (4,8,47) | 8. Issues > 8.4 Adding issues to the tracker |
| 16. | 58 | NEW | 3.1 Setting up > 3.1.2 Creating a GitLab account and setting up SSH |
| 17. | 57 | NEW | 4.4 Configuring make > 4.4.2 Running autogen.sh |
| 18. | 55 | (12,13,30) | 11. Release work > 11.3 Major release checklist |
| 19. | 53 | (27,15,11) | 10. Programming work > 10.8 Tracing object relationships |
| 20. | 49 | (9,23,17) | 4.2 Requirements > 4.2.1 Requirements for running LilyPond |
| 21. | 37 | NEW | 10.7 Debugging LilyPond > 10.7.5 Debugging skylines |
| 22. | 30 | (14,3,13) | 5.9.3 Documentation translation maintenance > Check state of translation |
| 23. | 26 | (26,0,0) | 4.6 Post-compilation options > 4.6.2 Generating documentation |
| 24. | 25 | (25,0,0) | 3.2 Git cheat sheet > Uploading your branch for review |
| 25. | 24 | (16,8,0) | 3.3 Lifecycle of a merge request > 3.3.2 Automated testing |
| 26. | 23 | NEW | 4.4 Configuring make > 4.4.1 Build modes |
| 27. | 23 | NEW | 10.4 Finding functions > 10.4.4 Using TAGS support |
| 28. | 22 | (2,20,0) | 7. LSR work > 7.3 Approving snippets |
| 29. | 21 | (0,14,7) | 3. Working with source code > 3.6 Further Git documentation resources |
| 30. | 21 | NEW | 13. Administrative policies > 13.3 Performing yearly copyright update (“grand-replace”) |
| 31. | 16 | (0,16,0) | 4.4.3 Running configure > Configuring target directories |
| 32. | 16 | (0,8,8) | 5.7.2 Scripts to create documentation > Regenerating menus |
| 33. | 15 | (0,0,15) | 5. Documentation work > 5.9 Translating the documentation |
| 34. | 14 | (0,4,10) | 5.4 Texinfo introduction and usage policy > 5.4.3 Sectioning commands |
| 35. | 13 | (0,0,13) | 10.9 Adding or modifying features > 10.9.3 Write convert-ly rule |
| 36. | 12 | (0,2,10) | 5.4 Texinfo introduction and usage policy > 5.4.4 LilyPond formatting |
| 37. | 11 | NEW | 4.4 Configuring make > 4.4.3 Running configure |
| 38. | 10 | (8,2,0) | 3.2 Git cheat sheet > Amending and reverting changes |
| 39. | 10 | (10,0,0) | 3.3 Lifecycle of a merge request > 3.3.1 Uploading a patch for review |
| 40. | 10 | (0,1,9) | 5.9 Translating the documentation > 5.9.4 Technical background |
| 41. | 10 | NEW | 13. Administrative policies > 13.1 LilyPond is GNU Software |
| 42. | 9 | (8,1,0) | 3.2 Git cheat sheet > Deleting branches |
| 43. | 9 | (9,0,0) | 3.3 Lifecycle of a merge request > 3.3.3 Patch countdown |
| 44. | 9 | (0,8,1) | 4. Compiling > 4.3 Getting the source code |
| 45. | 8 | (2,6,0) | 3.2 Git cheat sheet > Switching branches |
| 46. | 8 | (0,8,0) | 4.4.3 Running configure > Checking build dependencies |
| 47. | 7 | (0,0,7) | 5.4.6 Syntax survey > Special characters |
| 48. | 7 | (0,4,3) | 5.4.6 Syntax survey > Miscellany |
| 49. | 7 | (0,6,1) | 5.9.2 Documentation translation details > Translating the Web site and other Texinfo documentation |
| 50. | 7 | (0,4,3) | 5.9.3 Documentation translation maintenance > Maintaining without updating translations |
| 51. | 7 | (1,5,1) | 7. LSR work > 7.1 Introduction to LSR |
| 52. | 7 | (1,6,0) | 7. LSR work > 7.6 Renaming a snippet |
| 53. | 6 | (1,2,3) | Contributor's Guide > 13. Administrative policies |
| 54. | 5 | (2,2,1) | 4. Compiling > 4.4 Configuring make |
| 55. | 5 | (0,1,4) | 4. Compiling > 4.9 Build system |
| 56. | 5 | (0,2,3) | 5.4.6 Syntax survey > Fixed-width font |
| 57. | 5 | (5,0,0) | 10.11 Engraver tutorial > 10.11.1 Useful methods for information processing |
| 58. | 4 | (0,4,0) | 1. Introduction to contributing > 1.2 Overview of work flow |
| 59. | 4 | (0,3,1) | 3.1 Setting up > 3.1.3 Cloning and forking the repository |
| 60. | 4 | (4,0,0) | 4.2 Requirements > 4.2.2 Requirements for compiling LilyPond |
| 61. | 4 | (0,4,0) | 4.2.2 Requirements for compiling LilyPond > Fedora |
| 62. | 4 | (0,4,0) | 5.4 Texinfo introduction and usage policy > 5.4.7 Other text concerns |
| 63. | 4 | (1,3,0) | 6. Website work > 6.2 Uploading website |
| 64. | 4 | (0,3,1) | 7. LSR work > 7.7 Updating the LSR to a new version |
| 65. | 4 | (0,0,4) | 13. Administrative policies > 13.2 Environment variables |
| 66. | 3 | (0,1,2) | 2. Quick start > 2.1 LilyDev |
| 67. | 3 | (0,2,1) | 3. Working with source code > 3.7 Repository directory structure |
| 68. | 3 | (0,3,0) | 4.2.2 Requirements for compiling LilyPond > Linux Mint |
| 69. | 3 | (0,3,0) | 4.2.2 Requirements for compiling LilyPond > OpenSUSE |
| 70. | 3 | (0,3,0) | 4.2.2 Requirements for compiling LilyPond > Ubuntu |
| 71. | 3 | (1,1,1) | 5.5 Documentation policy > 5.5.2 Section organization |
| 72. | 3 | (0,1,2) | Contributor's Guide > 8. Issues |
| 73. | 3 | (0,3,0) | 10.6 Warnings, Errors, Progress and Debug Output > Functions for debug and log output |
| 74. | 3 | (0,1,2) | Contributor's Guide > 11. Release work |
| 75. | 2 | (0,2,0) | 3.1 Setting up > 3.1.1 Installing Git |
| 76. | 2 | (0,2,0) | 4.4.3 Running configure > Configuration options |
| 77. | 2 | (0,1,1) | 5. Documentation work > 5.1 Introduction to documentation work |
| 78. | 2 | (0,2,0) | 5.9 Translating the documentation > 5.9.1 Getting started with documentation translation |
| 79. | 2 | (0,1,1) | 5.9.1 Getting started with documentation translation > Translation requirements |
| 80. | 2 | (0,2,0) | 5.9.2 Documentation translation details > Adding a Texinfo manual |
| 81. | 2 | (1,1,0) | 5.9 Translating the documentation > 5.9.3 Documentation translation maintenance |
| 82. | 2 | (1,0,1) | Contributor's Guide > 7. LSR work |
| 83. | 2 | (0,2,0) | 8. Issues > 8.3 Issue classification |
| 84. | 2 | (0,2,0) | 10.2 LilyPond programming languages > 10.2.3 GNU Bison |
| 85. | 2 | (0,2,0) | 10.2 LilyPond programming languages > 10.2.5 GUILE or Scheme |
| 86. | 2 | (2,0,0) | 10. Programming work > 10.7 Debugging LilyPond |
| 87. | 2 | (0,2,0) | 10.9 Adding or modifying features > 10.9.5 Manually update documentation |
| 88. | 2 | (2,0,0) | 10.15 Scheme->C interface > 10.15.2 Conversion |
| 89. | 2 | (0,2,0) | 10.17 LilyPond miscellany > 10.17.4 Articulations on EventChord |
|
Details
|
|---|
| "How much is there to read in the Contributor's Guide?" |
|---|
- 245 total sections, averaging 46 lines each (totaling 11154 lines or ~199 pdf pages)
- 12 New sections, averaging 70 lines each (totaling 839 lines or ~15 pdf pages)
- 77 Changed* sections, averaging 22 modified lines each (totaling 1686 lines or ~30 pdf pages)
- in all, ~36% of the Contributor's Guide sections have been modified.
|
| * Not counting/highlighting 45 sections with only 1 modified line. |
| Top |
|
Caveats
|
|---|
-
Documentation sections that are generated automatically by the lilypond build process
(typically lists in an appendix)
are not available to this analysis, which is based on static source files.
Such sections are colored gray in the table of contents
but brighten when hovered over.
-
Very large changes may be due to extensive reformatting without significant change in content.
-
Division of a huge section into a several subsections
(e.g. by promoting simple headings into subsection declarations) may appear as a huge deletion in that section,
followed by the addition of several large new subsections, even though only a few lines of source were changed.
Consulting the "(add,chg,del)" statistics will reveal such cases.
-
Simple changes to the name of a section are usually detected,
but more complex changes may cause a mismatch, causing those sections to be listed as New in the new release
and Old/Obsolete in the old release.
Check the list of Old/Obsolete section names if you suspect such a mismatch.
|
| Top |
|
Tips
|
|---|
- Use your browser's "find in page" (e.g. "Ctrl-F") to search the fully expanded table of contents.
All your matches will be highlighted until you do another search,
making it easy to scroll or step through the results.
-
Searches will cover both the table of contents on the left and the main page on the right.
So it's also a way to find the details on the right for sections you've found on the left.
-
Clicking on a link will bring up the official documentation for that section in another tab.
Alternatively, you can usually right click to open in a new window, allowing you to still see
the expanded table of contents in the original window as a visual guide.
|
| Top |
This unofficial page was generated for other Lilypond users by ly-mandiff.pl version 2023-01-04.
|