x86/vsyscall: Fix documentation to reflect the default mode

Message ID 20230111193211.1987047-1-sohil.mehta@intel.com
State New
Headers
Series x86/vsyscall: Fix documentation to reflect the default mode |

Commit Message

Sohil Mehta Jan. 11, 2023, 7:32 p.m. UTC
  The default vsyscall mode has been updated from emulate to xonly for a
while. Update the kernel-parameters doc to reflect that.

Fixes: 625b7b7f79c6 ("x86/vsyscall: Change the default vsyscall mode to xonly")
Cc: Andy Lutomirski <luto@kernel.org>
Signed-off-by: Sohil Mehta <sohil.mehta@intel.com>
Reviewed-by: Tony Luck <tony.luck@intel.com>
---
Do documentation fixes typically get backported to stable? I haven't included
a stable cc assuming they do not.

 Documentation/admin-guide/kernel-parameters.txt | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
  

Comments

Kees Cook Jan. 12, 2023, 9:32 p.m. UTC | #1
On Wed, Jan 11, 2023 at 07:32:11PM +0000, Sohil Mehta wrote:
> The default vsyscall mode has been updated from emulate to xonly for a
> while. Update the kernel-parameters doc to reflect that.
> 
> Fixes: 625b7b7f79c6 ("x86/vsyscall: Change the default vsyscall mode to xonly")
> Cc: Andy Lutomirski <luto@kernel.org>
> Signed-off-by: Sohil Mehta <sohil.mehta@intel.com>

Reviewed-by: Kees Cook <keescook@chromium.org>
  
Jonathan Corbet Jan. 19, 2023, 9:24 p.m. UTC | #2
Sohil Mehta <sohil.mehta@intel.com> writes:

> The default vsyscall mode has been updated from emulate to xonly for a
> while. Update the kernel-parameters doc to reflect that.
>
> Fixes: 625b7b7f79c6 ("x86/vsyscall: Change the default vsyscall mode to xonly")
> Cc: Andy Lutomirski <luto@kernel.org>
> Signed-off-by: Sohil Mehta <sohil.mehta@intel.com>
> Reviewed-by: Tony Luck <tony.luck@intel.com>
> ---
> Do documentation fixes typically get backported to stable? I haven't included
> a stable cc assuming they do not.
>
>  Documentation/admin-guide/kernel-parameters.txt | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)

Applied, thanks.

jon
  
Andy Lutomirski Jan. 21, 2023, 4:58 p.m. UTC | #3
On Thu, Jan 19, 2023, at 1:24 PM, Jonathan Corbet wrote:
> Sohil Mehta <sohil.mehta@intel.com> writes:
>
>> The default vsyscall mode has been updated from emulate to xonly for a
>> while. Update the kernel-parameters doc to reflect that.
>>
>> Fixes: 625b7b7f79c6 ("x86/vsyscall: Change the default vsyscall mode to xonly")
>> Cc: Andy Lutomirski <luto@kernel.org>
>> Signed-off-by: Sohil Mehta <sohil.mehta@intel.com>
>> Reviewed-by: Tony Luck <tony.luck@intel.com>
>> ---
>> Do documentation fixes typically get backported to stable? I haven't included
>> a stable cc assuming they do not.
>>
>>  Documentation/admin-guide/kernel-parameters.txt | 8 ++++----
>>  1 file changed, 4 insertions(+), 4 deletions(-)
>
> Applied, thanks.

Belated ack!  Sohil, thanks for the fix.

>
> jon
  

Patch

diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
index 6cfa6e3996cf..87f0b645922c 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -6756,11 +6756,11 @@ 
 			functions are at fixed addresses, they make nice
 			targets for exploits that can control RIP.
 
-			emulate     [default] Vsyscalls turn into traps and are
-			            emulated reasonably safely.  The vsyscall
-				    page is readable.
+			emulate     Vsyscalls turn into traps and are emulated
+			            reasonably safely.  The vsyscall page is
+				    readable.
 
-			xonly       Vsyscalls turn into traps and are
+			xonly       [default] Vsyscalls turn into traps and are
 			            emulated reasonably safely.  The vsyscall
 				    page is not readable.