Add draft release notes for RBTools 0.7

Review Request #6720 — Created Jan. 1, 2015 and submitted

Information

RBTools
master
7c8faf6...

Reviewers

This change has draft relnotes for everything that is present in master but not
release-0.6.x.

 
Description From Last Updated

We should link to the aliases docs. (Will need to define a reference point in rbt/aliases.rst along with this).

chipx86chipx86

"command lines".

chipx86chipx86

We should mention that the Windows installer is based on work by Bruce Cran, and make sure he's in the …

chipx86chipx86

"There are now installers ..."

chipx86chipx86

Let's not say "less-technical users." I don't think people will take kindly to that. Really, we want people to use …

chipx86chipx86

"include an"

chipx86chipx86

"config file"

chipx86chipx86

This should also mention that the patch is by Barret.

chipx86chipx86

To get the options to link correctly, can you add this below the section and before the bullet points: :program: …

chipx86chipx86

"Added" and "command line"

chipx86chipx86

This is only one half of the command. I would say something like: "The new rbt land command is a …

chipx86chipx86

This is now optional and doesn't happen by default.

chipx86chipx86

"Added"

chipx86chipx86

Missing period.

chipx86chipx86

"Enhanced"

chipx86chipx86

"unapplied"

chipx86chipx86

"Added" and "command line"

chipx86chipx86

"command line" and "config file"

chipx86chipx86

We should mention that this only happens on RB 2.0+.

chipx86chipx86

Can we move the second sentence into its own paragraph, like we did above for rbt land?

chipx86chipx86

Can you move the :command: bit to the next line? I don't remember if ReST technically allows these to span …

chipx86chipx86

Can we put "The old behavior ..." in a new paragraph? Helps it stand out.

chipx86chipx86

Can we mention that this also works with the new -C?

chipx86chipx86

This somehow reads a bit oddly. Maybe: "Subversion repositories configured to require user credentials for each command could not be …

chipx86chipx86

"config file"

chipx86chipx86

Same comment about "The old behavior"

chipx86chipx86

Let's link to Power Pack. Also, we should drop the "the".

chipx86chipx86

No period.

chipx86chipx86

No period.

chipx86chipx86

No period.

chipx86chipx86

Sorry, I had this wrong. Should be: .. program:: rbt patch

chipx86chipx86

Can we make the "only supported" sentence its own paragraph after this one, to match the other entries that do …

chipx86chipx86
reviewbot
  1. Tool: PEP8 Style Checker
    Ignored Files:
        docs/releasenotes/0.7.rst
    
    
    
    Tool: Pyflakes
    Ignored Files:
        docs/releasenotes/0.7.rst
    
    
  2. 
      
chipx86
  1. 
      
  2. docs/releasenotes/0.7.rst (Diff revision 1)
     
     
     
     

    We should link to the aliases docs. (Will need to define a reference point in rbt/aliases.rst along with this).

  3. docs/releasenotes/0.7.rst (Diff revision 1)
     
     

    "command lines".

  4. docs/releasenotes/0.7.rst (Diff revision 1)
     
     

    We should mention that the Windows installer is based on work by Bruce Cran, and make sure he's in the Contributors list.

  5. docs/releasenotes/0.7.rst (Diff revision 1)
     
     

    "There are now installers ..."

  6. docs/releasenotes/0.7.rst (Diff revision 1)
     
     

    Let's not say "less-technical users." I don't think people will take kindly to that. Really, we want people to use the installers anyway for these platforms, as it's guaranteeing a particular environment, making our lives easier too.

    How about just "This simplifies distribution and installation on these platforms."

  7. docs/releasenotes/0.7.rst (Diff revision 1)
     
     

    "include an"

  8. docs/releasenotes/0.7.rst (Diff revision 1)
     
     

    "config file"

  9. docs/releasenotes/0.7.rst (Diff revision 1)
     
     
     
     
     
     
     

    This should also mention that the patch is by Barret.

  10. docs/releasenotes/0.7.rst (Diff revision 1)
     
     
     

    To get the options to link correctly, can you add this below the section and before the bullet points:

    :program: rbt diff
    

    Same with other sections.

  11. docs/releasenotes/0.7.rst (Diff revision 1)
     
     

    "Added" and "command line"

  12. docs/releasenotes/0.7.rst (Diff revision 1)
     
     
     

    This is only one half of the command.

    I would say something like:

    "The new rbt land command is a quick and easy way to push a change that has been reviewed on Review Board to the upstream repository. The change may be in a local branch or stored as a patch on Review Board."

    I'd also make the "When running against ..." a separate paragraph.

  13. docs/releasenotes/0.7.rst (Diff revision 1)
     
     

    This is now optional and doesn't happen by default.

  14. docs/releasenotes/0.7.rst (Diff revision 1)
     
     

    "Added"

  15. docs/releasenotes/0.7.rst (Diff revision 1)
     
     

    Missing period.

  16. docs/releasenotes/0.7.rst (Diff revision 1)
     
     

    "Enhanced"

  17. docs/releasenotes/0.7.rst (Diff revision 1)
     
     

    "unapplied"

  18. docs/releasenotes/0.7.rst (Diff revision 1)
     
     

    "Added" and "command line"

  19. docs/releasenotes/0.7.rst (Diff revision 1)
     
     

    "command line" and "config file"

  20. docs/releasenotes/0.7.rst (Diff revision 1)
     
     
     

    We should mention that this only happens on RB 2.0+.

  21. docs/releasenotes/0.7.rst (Diff revision 1)
     
     
     
     
     
     

    Can we move the second sentence into its own paragraph, like we did above for rbt land?

  22. docs/releasenotes/0.7.rst (Diff revision 1)
     
     
     

    Can you move the :command: bit to the next line? I don't remember if ReST technically allows these to span multiple lines, but it definitely messes up syntax highlighting here.

  23. docs/releasenotes/0.7.rst (Diff revision 1)
     
     
     

    Can we put "The old behavior ..." in a new paragraph? Helps it stand out.

  24. docs/releasenotes/0.7.rst (Diff revision 1)
     
     

    Can we mention that this also works with the new -C?

  25. docs/releasenotes/0.7.rst (Diff revision 1)
     
     
     

    This somehow reads a bit oddly. Maybe:

    "Subversion repositories configured to require user credentials for each command could not be used with RBTools. These credentials can now be provided using the new --svn-username and ..."

  26. docs/releasenotes/0.7.rst (Diff revision 1)
     
     

    "config file"

  27. docs/releasenotes/0.7.rst (Diff revision 1)
     
     
     

    Same comment about "The old behavior"

  28. docs/releasenotes/0.7.rst (Diff revision 1)
     
     

    Let's link to Power Pack. Also, we should drop the "the".

  29. docs/releasenotes/0.7.rst (Diff revision 1)
     
     

    No period.

  30. docs/releasenotes/0.7.rst (Diff revision 1)
     
     

    No period.

  31. docs/releasenotes/0.7.rst (Diff revision 1)
     
     

    No period.

  32. 
      
david
reviewbot
  1. Tool: PEP8 Style Checker
    Ignored Files:
        docs/rbtools/rbt/aliases.rst
        docs/releasenotes/index.rst
        docs/releasenotes/0.7.rst
    
    
    
    Tool: Pyflakes
    Ignored Files:
        docs/rbtools/rbt/aliases.rst
        docs/releasenotes/index.rst
        docs/releasenotes/0.7.rst
    
    
  2. 
      
chipx86
  1. 
      
  2. docs/releasenotes/0.7.rst (Diff revision 2)
     
     

    Sorry, I had this wrong. Should be:

    .. program:: rbt patch
    
  3. docs/releasenotes/0.7.rst (Diff revision 2)
     
     

    Can we make the "only supported" sentence its own paragraph after this one, to match the other entries that do that?

  4. 
      
david
reviewbot
  1. Tool: PEP8 Style Checker
    Ignored Files:
        docs/rbtools/rbt/aliases.rst
        docs/releasenotes/index.rst
        docs/releasenotes/0.7.rst
    
    
    
    Tool: Pyflakes
    Ignored Files:
        docs/rbtools/rbt/aliases.rst
        docs/releasenotes/index.rst
        docs/releasenotes/0.7.rst
    
    
  2. 
      
chipx86
  1. Ship It!
  2. 
      
david
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to master (786aa63)
Loading...