Plan for P1/P2 clean-up
From Audacity Development Manual
Revision as of 08:52, 13 May 2016 by PeterSampson (talk | contribs) (→P1: The number of P1s is growing a bit so I decided to start doumenting them here)
Contents
Permanent P1's
- Perform a link check using Xenu or other software.
- Check at Code Review 2.1.3 that there are no commits listed in "Not assessed" and that Status reads per the latest commit at https://github.com/audacity/audacity.
- Check the FAQ! There are almost always things there too that need changing for the next release.
- Change the version number on the front of the Manual from "Audacity 2.x.x-alpha Development Manual" to "Audacity 2.x.x Manual" (whatever the current release is).
- Change the version number of the Manual at Unzipping the Manual in the "x"'s as below:
Gale 06Feb15: I can recall writing instructions for dumping the Manual on Mac, and thought those instructions were linked to here. Please advise if anyone can shed any light on that.
- Until we have a separate subdomain for the released and alpha Manual, $wgSitename in LocalSettings.php is set to "Audacity Development Manual" to make clear what it is. However this means that for the few minutes while the Manual is dumped for release, Gale or Steve need to change $wgSitename to "Audacity Manual".
After release
- Log in to https://www.virustotal.com/en/, upload the new Windows EXE file and scan it. On the results page, add a comment in the form
| #audacity x.x.x for Windows (EXE) |
- Change all version numbers on the front page of the Manual as in the "x" as below. Typically, this would increment just the third number by 1:
- Audacity 2.x.x-alpha Development Manual.
- This online Manual is only for the latest 2.x.x-alpha development code. The online Manual for the current 2.x.x release is here. Click here for legacy 1.2 documentation.
- Use Help > Manual (in browser) in the current 2.x.x release to access an installed copy of the Manual.
- You can download and install the 2.x.x Manual if the Manual is not installed.
- Update the Wikipedia page
- Peter 22Jan16:Updated for 2.1.2
P1
- 2.1.3 will officially support Windows 10 so references to specific Windows versions will need updating, or changed to a generic "Windows Vista and later". Windows 10 is supposed to be the last version of Windows, perpetually updated, so we may want to be specific. It makes things easier for users new to computers who may not know Windows version history.
- Peter 11Apr16: I've had a good comb through this morning and made what I think are all the necessary changes . In some cases I used "Vista or later" in many others I was explicit. If and when we eventually stop supporting Windows XP we can tidy up the Manual considerably.
- Peter 12Apr16: And today I did a similar trawl in the Wiki fixing that up for Windows 10
- Effect Menu AU Effect Options text incorrect
- Front page Now that we have Paul's new buttons for Quick-Play and Scrub Bar we must of necessity update the amazing imagemap.
- Warnings Preferences
created by Gale has somehow gone missing - Status Bar messages have changed - text and images need updating
- Installing and updating Audacity on Linux Linux image required (to replace W7) for Libraries Preferences
P2s that may block a release
- Mixing Audio Tracks: There is no mention here or in Tracks Menu of how render handles white space before the audio begins or audio before zero. Should there be? Current behavior following r11248 is to preserve the clip length by no longer rendering white space between time zero and first audio as silence, and to preserve audio before time zero instead of discarding it. So people who want to export tracks with silent lead-ins preserved now have to generate silence after rendering. I think that tip at least should be in this page.
- Peter 04Feb14: we have carried this issue through several releases, since December 2011. It has never been a blocker previously.
P2 proofread/review needed
See Pages that link to "ToDo-2R"
Placeholders
General Placeholders
See Pages that link to "ToDo-2P"
Placeholder for WDM-KS
WDM-KS is definitely turned off for 2.1.0 and 2.1.1
The following pages currently have P2s associated with WDM-KS that may become P1s:
- Glossary
- Device Toolbar
- Devices Preferences
- Tutorial - Selecting Your Recording Device
- Tutorial - Recording Computer Playback on Windows
Wiki P2s re WDM-KS
These above three P2s in the Wiki - all relate to WDM-KS
P2 placeholders for VST presets Mac bug
- In Effect Menu#vst_presets - for removal of Mac-only advice if file extension bug is fixed
P2 placeholders for bug 825
- Sync-Locked Track Groups The "Editing a clip can move other clips" option in Tracks Preferences seems to override Sync-Locked Track Groups except where bugs cause other behavior. Probably the behavior is too buggy and confusing to be documented now, so this is a placeholder for when the behavior is bug fixed and better signposted.
- Peter 29Jan15: Logged as P3 on Bugzilla #825
- Tracks Preferences: The "Editing a clip can move other clips" option in Tracks Preferences seems to override Sync-Locked Track Groups except where bugs cause other behavior. Probably the behavior is too buggy and confusing to be documented now, so this is a placeholder for when the behavior is bug fixed and better signposted.
- Peter 29Jan15: Logged as P3 on Bugzilla #825
P2 placeholder for Audacity compilation on Linux against FFmpeg
- Gale 10Sep14: FAQ:Installation_and_Plug-Ins#FFmpeg version support - Placeholder P2 to change the text about dynamic loading if bug 540 is fixed and to monitor compiling status on different distros.
Permanent P1's completed
None
Completed items
None