From: Zachary Ware <zachary.ware@gmail.com>
Date: Sat, 13 May 2017 14:30:20 +0000 (-0500)
Subject: bpo-11681: Document the `-b` and `-bb` options (GH-1562)
X-Git-Tag: v2.7.14rc1~152
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=f6c6d1e2304a06efdf65c60c3e1c6bbe1f192fd0;p=python

bpo-11681: Document the `-b` and `-bb` options (GH-1562)
---

diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst
index c6b372b184..b567818858 100644
--- a/Doc/using/cmdline.rst
+++ b/Doc/using/cmdline.rst
@@ -24,7 +24,7 @@ Command line
 
 When invoking Python, you may specify any of these options::
 
-    python [-BdEiOQsRStuUvVWxX3?] [-c command | -m module-name | script | - ] [args]
+    python [-bBdEiOQsRStuUvVWxX3?] [-c command | -m module-name | script | - ] [args]
 
 The most common use case is, of course, a simple invocation of a script::
 
@@ -191,6 +191,19 @@ Generic options
 Miscellaneous options
 ~~~~~~~~~~~~~~~~~~~~~
 
+.. cmdoption:: -b
+
+   Issue a warning when comparing :class:`unicode` with :class:`bytearray`.
+   Issue an error when the option is given twice (:option:`!-bb`).
+
+   Note that, unlike the corresponding Python 3.x flag, this will **not** emit
+   warnings for comparisons between :class:`str` and :class:`unicode`.
+   Instead, the ``str`` instance will be implicitly decoded to ``unicode`` and
+   Unicode comparison used.
+
+   .. versionadded:: 2.6
+
+
 .. cmdoption:: -B
 
    If given, Python won't try to write ``.pyc`` or ``.pyo`` files on the
diff --git a/Modules/main.c b/Modules/main.c
index 73e87e08fd..a6edf822d0 100644
--- a/Modules/main.c
+++ b/Modules/main.c
@@ -62,6 +62,8 @@ static char *usage_line =
 /* Long usage message, split into parts < 512 bytes */
 static char *usage_1 = "\
 Options and arguments (and corresponding environment variables):\n\
+-b     : issue warnings about comparing bytearray with unicode\n\
+         (-bb: issue errors)\n\
 -B     : don't write .py[co] files on import; also PYTHONDONTWRITEBYTECODE=x\n\
 -c cmd : program passed in as string (terminates option list)\n\
 -d     : debug output from parser; also PYTHONDEBUG=x\n\