Skip to content

Commit 33ad89d

Browse files
3rt7dbaluta
authored andcommitted
Documentation: teaching: fix typo
Signed-off-by: Erfan Zamani <erfanzamani3445@gmail.com>
1 parent e6ab6d0 commit 33ad89d

File tree

3 files changed

+22
-22
lines changed

3 files changed

+22
-22
lines changed

Documentation/teaching/info/contributing.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ All information required for making a contribution can be found in the
1212
`linux-kernel-labs Linux repo <https://github.com/linux-kernel-labs/linux>`_.
1313
In order to change anything, you need to create a Pull Request (``PR``)
1414
from your own fork to this repository.
15-
The PR will be reviewed by ther members of the team and will be merged once
16-
any pottential issue is fixed.
15+
The PR will be reviewed by the members of the team and will be merged once
16+
any potential issue is fixed.
1717

1818
********************
1919
Repository structure
@@ -79,7 +79,7 @@ Forking the repository
7979

8080
.. code-block:: bash
8181
82-
$ git remote add my_fork git@github.com:<your_user>/linux.git
82+
$ git remote add my_fork git@github.com:<your_username>/linux.git
8383
8484
Now, you can push to your fork by using ``my_fork`` instead of ``origin``
8585
(e.g. ``git push my_fork master``).
@@ -89,7 +89,7 @@ Creating a pull request
8989

9090
.. warning::
9191

92-
Pull requests must be created from their own branches, wich are started from
92+
Pull requests must be created from their own branches, which are started from
9393
``master``.
9494

9595
1. Go to the master branch and make sure you have no local changes:
@@ -148,7 +148,7 @@ Creating a pull request
148148
149149
student@eg106:~/src/linux$ git push my_fork <your_branch_name>
150150
151-
6. Open the Pull Pequest
151+
6. Open the Pull Request
152152

153153
* Go to https://github.com and open your forked repository page
154154
* Click ``New pull request``.

Documentation/teaching/labs/arm_kernel_development.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Lab objectives
66
==============
77

88
* get a feeling of what System on a Chip (SoC) means
9-
* get familiar with embedded world using ARM as support architecture
9+
* get familiar with embedded world using ARM as a supported architecture
1010
* understand what a Board Support Package means (BSP)
1111
* compile and boot an ARM kernel with Qemu using i.MX6UL platform as an example
1212
* get familiar with hardware description using Device Trees

Documentation/teaching/lectures/syscalls.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Linux system calls implementation
2828

2929
At a high level system calls are "services" offered by the kernel to
3030
user applications and they resemble library APIs in that they are
31-
described as a function call with a name, parameters and return value.
31+
described as a function call with a name, parameters, and return value.
3232

3333
.. slide:: System Calls as Kernel services
3434
:inline-contents: True
@@ -90,8 +90,8 @@ actual system calls in order to make it easier for applications to use
9090
them.
9191

9292
When a user to kernel mode transition occurs, the execution flow is
93-
interrupted and it is transfered to a kernel entry point. This is
94-
similar with how interrupts and exception are handled (in fact on some
93+
interrupted and it is transferred to a kernel entry point. This is
94+
similar to how interrupts and exceptions are handled (in fact on some
9595
architectures this transition happens as a result of an exception).
9696

9797
The system call entry point will save registers (which contains values
@@ -100,7 +100,7 @@ parameters) on stack and then it will continue with executing the
100100
system call dispatcher.
101101

102102
.. note:: During the user - kernel mode transition the stack is also
103-
switched from ther user stack to the kernel stack. This is
103+
switched from the user stack to the kernel stack. This is
104104
explained in more details in the interrupts lecture.
105105

106106
.. slide:: Example of Linux system call setup and handling
@@ -247,7 +247,7 @@ System call parameters handling
247247

248248
Handling system call parameters is tricky. Since these values are
249249
setup by user space, the kernel can not assume correctness and must
250-
always verify them throughly.
250+
always verify them thoroughly.
251251

252252
Pointers have a few important special cases that must be checked:
253253

@@ -264,7 +264,7 @@ Since system calls are executed in kernel mode, they have access to
264264
kernel space and if pointers are not properly checked user
265265
applications might get read or write access to kernel space.
266266

267-
For example, lets consider the case where such a check is not made for
267+
For example, let's consider the case where such a check is not made for
268268
the read or write system calls. If the user passes a kernel-space
269269
pointer to a write system call then it can get access to kernel data
270270
by later reading the file. If it passes a kernel-space pointer to a
@@ -281,7 +281,7 @@ read system call then it can corrupt kernel memory.
281281

282282
Likewise, if a pointer passed by the application is invalid
283283
(e.g. unmapped, read-only for cases where it is used for writing), it
284-
could "crash" the kernel. There two approaches that could be used:
284+
could "crash" the kernel. Two approaches could be used:
285285

286286
.. slide:: Invalid pointers handling approaches
287287
:inline-contents: True
@@ -318,7 +318,7 @@ space to determine the cause:
318318
But in the last two cases we don't have enough information to
319319
determine the cause of the fault.
320320

321-
In order to solve this issue Linux uses special APIs (e.g
321+
In order to solve this issue, Linux uses special APIs (e.g
322322
:c:func:`copy_to_user`) to accesses user space that are specially
323323
crafted:
324324

@@ -360,8 +360,8 @@ system call implementation, in a way that does not impact libc with
360360
having to track the CPU capabilities in conjunction with the kernel
361361
version.
362362

363-
For example: x86 has two ways of issuing system calls: int 0x80 and
364-
sysenter. The later is significantly faster so it should be used when
363+
For example, x86 has two ways of issuing system calls: int 0x80 and
364+
sysenter. The latter is significantly faster so it should be used when
365365
available. However, it is only available for processors newer than
366366
Pentium II and only for kernel versions greater than 2.6.
367367

@@ -392,7 +392,7 @@ With VDSO the system call interface is decided by the kernel:
392392

393393

394394

395-
An interesting development of the VDSO are the virtual system calls
395+
An interesting development of the VDSO is the virtual system calls
396396
(vsyscalls) which run directly from user space. These vsyscalls are
397397
also part of VDSO and they are accessing data from the VDSO page that
398398
is either static or modified by the kernel in a separate read-write
@@ -417,9 +417,9 @@ Accessing user space from system calls
417417

418418
As we mentioned earlier, user space must be accessed with special APIs
419419
(:c:func:`get_user`, :c:func:`put_user`, :c:func:`copy_from_user`,
420-
:c:func:`copy_to_user`) that check wether the pointer is in user space
420+
:c:func:`copy_to_user`) that check whether the pointer is in user space
421421
and also handle the fault if the pointer is invalid. In case of invalid
422-
pointers they return a non zero value.
422+
pointers, they return a non-zero value.
423423

424424
.. slide:: Accessing user space from system calls
425425
:inline-contents: True
@@ -458,8 +458,8 @@ Let's examine the simplest API, get_user, as implemented for x86:
458458
})
459459
460460
461-
The implementation uses inline assembly, that allows inserting ASM
462-
sequences in C code and also handles access to / from variables in the
461+
The implementation uses inline assembly, which allows inserting ASM
462+
sequences in C code and also handles access to/from variables in the
463463
ASM code.
464464

465465
Based on the type size of the x variable, one of __get_user_1,
@@ -603,7 +603,7 @@ is accessed by the fault handler:
603603
}
604604
605605
606-
All it does is to set the return address to the one in the to field of
606+
All it does is to set the return address to the one in the field of
607607
the exception table entry which, in case of the get_user exception
608608
table entry, is bad_get_user which return -EFAULT to the caller.
609609

0 commit comments

Comments
 (0)