* Python 3 vs. @code{Python} 3 in python.texi
@ 2017-03-20 14:36 Yao Qi
2017-03-20 18:22 ` Eli Zaretskii
0 siblings, 1 reply; 4+ messages in thread
From: Yao Qi @ 2017-03-20 14:36 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: Tim Wiederhake, gdb-patches
Hi Eli,
Which one do we use in sentence "In XXX, the return
value is a @code{memoryview} object.", "Python 3" or
"@code{Python} 3"?
https://sourceware.org/ml/gdb-patches/2017-03/msg00039.html
We use "@code{Python} 3" for Inferior.read_memory,
....
@code{Inferior.write_memory} function. In @code{Python} 3, the return
value is a @code{memoryview} object.
so I suggested that we need to use "@code{Python} 3" for
consistency, but Tim believes "Python 3" should be used,
because "@code{python} is used when the actual "python" command
in GDB is meant, not the name of the language per-se."
--
Yao (齐尧)
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: Python 3 vs. @code{Python} 3 in python.texi
2017-03-20 14:36 Python 3 vs. @code{Python} 3 in python.texi Yao Qi
@ 2017-03-20 18:22 ` Eli Zaretskii
2017-03-22 12:43 ` [PATCH] Remove @code for python Yao Qi
0 siblings, 1 reply; 4+ messages in thread
From: Eli Zaretskii @ 2017-03-20 18:22 UTC (permalink / raw)
To: Yao Qi; +Cc: tim.wiederhake, gdb-patches
> From: Yao Qi <qiyaoltc@gmail.com>
> Date: Mon, 20 Mar 2017 14:36:42 +0000
> Cc: Tim Wiederhake <tim.wiederhake@intel.com>,
> "gdb-patches@sourceware.org" <gdb-patches@sourceware.org>
>
> Hi Eli,
> Which one do we use in sentence "In XXX, the return
> value is a @code{memoryview} object.", "Python 3" or
> "@code{Python} 3"?
> https://sourceware.org/ml/gdb-patches/2017-03/msg00039.html
>
> We use "@code{Python} 3" for Inferior.read_memory,
> ....
> @code{Inferior.write_memory} function. In @code{Python} 3, the return
> value is a @code{memoryview} object.
>
> so I suggested that we need to use "@code{Python} 3" for
> consistency, but Tim believes "Python 3" should be used,
> because "@code{python} is used when the actual "python" command
> in GDB is meant, not the name of the language per-se."
There's no reason to use @code for Python the name of a programming
language. If we do that in the manual, that is a mistake.
For 'python' the program, we should use @command{python}, not @code.
^ permalink raw reply [flat|nested] 4+ messages in thread
* [PATCH] Remove @code for python
2017-03-20 18:22 ` Eli Zaretskii
@ 2017-03-22 12:43 ` Yao Qi
2017-03-22 15:39 ` Eli Zaretskii
0 siblings, 1 reply; 4+ messages in thread
From: Yao Qi @ 2017-03-22 12:43 UTC (permalink / raw)
To: gdb-patches
There's no reason to use @code for Python the name of a programming
language.
gdb/doc:
2017-03-22 Yao Qi <yao.qi@linaro.org>
* python.texi (Inferiors In Python): Remove @code from Python.
---
gdb/doc/ChangeLog | 4 ++++
gdb/doc/python.texi | 2 +-
2 files changed, 5 insertions(+), 1 deletion(-)
diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index 8253cbe..5eb3a6c 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,3 +1,7 @@
+2017-03-22 Yao Qi <yao.qi@linaro.org>
+
+ * python.texi (Inferiors In Python): Remove @code from Python.
+
2017-03-21 Tim Wiederhake <tim.wiederhake@intel.com>
* python.texi (Recordings In Python): Document return type of
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 1fb8b25..ce5810e 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -2760,7 +2760,7 @@ return an empty tuple.
Read @var{length} addressable memory units from the inferior, starting at
@var{address}. Returns a buffer object, which behaves much like an array
or a string. It can be modified and given to the
-@code{Inferior.write_memory} function. In @code{Python} 3, the return
+@code{Inferior.write_memory} function. In Python 3, the return
value is a @code{memoryview} object.
@end defun
--
1.9.1
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] Remove @code for python
2017-03-22 12:43 ` [PATCH] Remove @code for python Yao Qi
@ 2017-03-22 15:39 ` Eli Zaretskii
0 siblings, 0 replies; 4+ messages in thread
From: Eli Zaretskii @ 2017-03-22 15:39 UTC (permalink / raw)
To: Yao Qi; +Cc: gdb-patches
> From: Yao Qi <qiyaoltc@gmail.com>
> Date: Wed, 22 Mar 2017 12:43:46 +0000
>
> There's no reason to use @code for Python the name of a programming
> language.
>
> gdb/doc:
>
> 2017-03-22 Yao Qi <yao.qi@linaro.org>
>
> * python.texi (Inferiors In Python): Remove @code from Python.
Thanks, this is OK.
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2017-03-22 15:39 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-03-20 14:36 Python 3 vs. @code{Python} 3 in python.texi Yao Qi
2017-03-20 18:22 ` Eli Zaretskii
2017-03-22 12:43 ` [PATCH] Remove @code for python Yao Qi
2017-03-22 15:39 ` Eli Zaretskii
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).