Permalink
Show file tree
Hide file tree
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
132 changed files
with
13,866 additions
and
0 deletions.
There are no files selected for viewing
BIN
+6 KB
Worksheets/.DS_Store
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
#+TITLE: Worksheets Guide | ||
#+AUTHOR: Dr Carey Pridgeon Dr Nazaraf Shah | ||
#+EMAIL: ab0475@coventry.ac.uk | ||
#+OPTIONS: toc:nil | ||
#+LaTeX_CLASS_OPTIONS: [minimal, t] | ||
#+STARTUP: showeverything | ||
* Worksheets | ||
- This Module is assessed by means of a Portfolio of Works. | ||
- The worksheets are graded to a total of 100, *if* you also complete the graded | ||
feedback session. | ||
- Whatever you get out of 100 is then that amount of 20% of the total module | ||
grade. | ||
- So, if you got 67, the amount the worksheets would contribute towards your | ||
final module grade would be .67*20 = *13.4%* | ||
- You must complete four of the worksheets provided. | ||
** Which worksheets to do | ||
- For all students the Terminal worksheet is compulsory. | ||
- If you do the bug fixing portfolio, the Mozilla worksheet is strongly | ||
recommended, as it contains everything you need to start the bug fixing | ||
process. | ||
- If you are less technically capable, the worksheets on Games and Licences are | ||
more research and thought based than technical knowledge based. You cannot | ||
avoid all the technical worksheets however. | ||
- If you are particularly interesting in optimisation, then the gdb and valgrind | ||
worksheet is recommended. | ||
- The Git Worksheet goes into more detail on Git than you have covered in | ||
previous modules. | ||
- The Emacs worksheet shows you how to use emacs to create documents of the type | ||
you will have already seen used on this module. | ||
** Structure of the Worksheets. | ||
- Where relevant the worksheets contain guides to all the commands they require | ||
you to use. | ||
- If they don't contain them they have instructions on where to go to find those | ||
instructions. | ||
** Worksheets Marks Breakdown | ||
| worksheet | grade | | ||
| *Linux Terminal* | 20 | | ||
| Mozilla | 20 | | ||
| gdb and Valgrind | 25 | | ||
| Licences | 20 | | ||
| Games | 20 | | ||
| git | 25 | | ||
| Gnuplot | 20 | | ||
- Four of the Worksheets must be completed to finish this portfolio component. | ||
- Some of the Worksheets cover aspects of the module content that will be | ||
useful for your work in completing other portfolio components. | ||
- To gain maximum possible marks you must complete the technical worksheets | ||
*completely*. | ||
- Partial completion will not qualify as done. | ||
* Graded Feedback | ||
- 10% of the mark for this component is available through a graded feedback | ||
session with a member of the teaching team. | ||
- To qualify for this you must have completed at least one worksheet and have | ||
started on the next. Ungraded feedback is available at any point. | ||
** Submission | ||
- On completion, the worksheets and the evidence specified for each should be | ||
placed in a single archive file and uploaded to Moodle. | ||
|
||
|
BIN
+96.1 KB
Worksheets/Worksheets_guide.pdf
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
% Created 2019-08-20 Tue 13:23 | ||
\documentclass[minimal, t]{article} | ||
\usepackage[utf8]{inputenc} | ||
\usepackage[T1]{fontenc} | ||
\usepackage{fixltx2e} | ||
\usepackage{graphicx} | ||
\usepackage{longtable} | ||
\usepackage{float} | ||
\usepackage{wrapfig} | ||
\usepackage{rotating} | ||
\usepackage[normalem]{ulem} | ||
\usepackage{amsmath} | ||
\usepackage{textcomp} | ||
\usepackage{marvosym} | ||
\usepackage{wasysym} | ||
\usepackage{amssymb} | ||
\usepackage{hyperref} | ||
\tolerance=1000 | ||
\author{Dr Carey Pridgeon Dr Nazaraf Shah} | ||
\date{\today} | ||
\title{Worksheets Guide} | ||
\hypersetup{ | ||
pdfkeywords={}, | ||
pdfsubject={}, | ||
pdfcreator={Emacs 25.3.50.1 (Org mode 8.2.10)}} | ||
\begin{document} | ||
|
||
\maketitle | ||
\section{Worksheets} | ||
\label{sec-1} | ||
\begin{itemize} | ||
\item This Module is assessed by means of a Portfolio of Works. | ||
\item The worksheets are graded to a total of 100, \textbf{if} you also complete the graded | ||
feedback session. | ||
\item Whatever you get out of 100 is then that amount of 20\% of the total module | ||
grade. | ||
\item So, if you got 67, the amount the worksheets would contribute towards your | ||
final module grade would be .67*20 = \textbf{13.4\%} | ||
\item You must complete four of the worksheets provided. | ||
\end{itemize} | ||
\subsection{Which worksheets to do} | ||
\label{sec-1-1} | ||
\begin{itemize} | ||
\item For all students the Terminal worksheet is compulsory. | ||
\item If you do the bug fixing portfolio, the Mozilla worksheet is strongly | ||
recommended, as it contains everything you need to start the bug fixing | ||
process. | ||
\item If you are less technically capable, the worksheets on Games and Licences are | ||
more research and thought based than technical knowledge based. You cannot | ||
avoid all the technical worksheets however. | ||
\item If you are particularly interesting in optimisation, then the gdb and valgrind | ||
worksheet is recommended. | ||
\item The Git Worksheet goes into more detail on Git than you have covered in | ||
previous modules. | ||
\item The Emacs worksheet shows you how to use emacs to create documents of the type | ||
you will have already seen used on this module. | ||
\end{itemize} | ||
\subsection{Structure of the Worksheets.} | ||
\label{sec-1-2} | ||
\begin{itemize} | ||
\item Where relevant the worksheets contain guides to all the commands they require | ||
you to use. | ||
\item If they don't contain them they have instructions on where to go to find those | ||
instructions. | ||
\end{itemize} | ||
\subsection{Worksheets Marks Breakdown} | ||
\label{sec-1-3} | ||
\begin{center} | ||
\begin{tabular}{lr} | ||
worksheet & grade\\ | ||
\textbf{Linux Terminal} & 20\\ | ||
Mozilla & 20\\ | ||
gdb and Valgrind & 25\\ | ||
Licences & 20\\ | ||
Games & 20\\ | ||
git & 25\\ | ||
Gnuplot & 20\\ | ||
\end{tabular} | ||
\end{center} | ||
\begin{itemize} | ||
\item Four of the Worksheets must be completed to finish this portfolio component. | ||
\item Some of the Worksheets cover aspects of the module content that will be | ||
useful for your work in completing other portfolio components. | ||
\item To gain maximum possible marks you must complete the technical worksheets | ||
\textbf{completely}. | ||
\item Partial completion will not qualify as done. | ||
\end{itemize} | ||
\section{Graded Feedback} | ||
\label{sec-2} | ||
\begin{itemize} | ||
\item 10\% of the mark for this component is available through a graded feedback | ||
session with a member of the teaching team. | ||
\item To qualify for this you must have completed at least one worksheet and have | ||
started on the next. Ungraded feedback is available at any point. | ||
\end{itemize} | ||
\subsection{Submission} | ||
\label{sec-2-1} | ||
\begin{itemize} | ||
\item On completion, the worksheets and the evidence specified for each should be | ||
placed in a single archive file and uploaded to Moodle. | ||
\end{itemize} | ||
% Emacs 25.3.50.1 (Org mode 8.2.10) | ||
\end{document} |
BIN
+10 KB
Worksheets/worksheets/.DS_Store
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,116 @@ | ||
#+TITLE: Mozilla Worksheet | ||
#+AUTHOR: Carey Pridgeon | ||
#+EMAIL: ab0475@coventry.ac.uk | ||
#+OPTIONS: toc:nil | ||
#+LaTeX_CLASS_OPTIONS: [minimal, t] | ||
#+STARTUP: showeverything | ||
* intro | ||
- In this worksheet you will either finish setting up your mozilla build | ||
environment in our virtual machine image, or start installing one on your own | ||
machine. | ||
** A quick note or two about installing your own | ||
- There are advantages, it will compile faster, the codebase will be easier to | ||
access, once you've downloaded it (this stage alone may take a while). | ||
- However, we cannot offer much help for you. You may get help from the | ||
community, that is, after all, what they do. | ||
- Here are some quick build guides | ||
- For Building on [[https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions/Simple_Firefox_build/Linux_and_MacOS_build_preparation][Linux]] | ||
- For Building on [[https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions/Windows_Prerequisites][Windows]] | ||
- For Building on [[https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions/Mac_OS_X_Prerequisites][MacOS]] | ||
- If you use a Mac and choose to do this, *DO NOT* upgrade to the new version of | ||
MacOS when it comes out halfway through the module. Wait till it's finished. | ||
** Virtual Machine stuff | ||
- Mozilla have their own virtual machine, but have proved to be so slow at | ||
updating it, to the point where it's essentially useless. As a result we have | ||
produced our own instead. | ||
- The download link for this, and associated information will be available on | ||
the Moodle page. It already has the base code for Mozilla, so you will only | ||
need to retrieve the latest revisions. | ||
- This may take a while, but it will vastly easier than downloading the entire | ||
codebase, which can take many hours, and is prone to failure. | ||
- All the instructions for this are on the Mozilla portion of the Moodle page, | ||
so head over there to get those. | ||
* Mercurial Commands we will use | ||
- *hg update* | ||
- refresh your local codebase so it is the same as the current version on the | ||
remote repositories head branch. (used when first using the codebase on our | ||
virtual machine image) | ||
- *hg strip tip --force* | ||
- Remove local edits | ||
- *hg pull -u* | ||
- Pull down the latest source | ||
- *hg tags* | ||
- List all tags in a mercurial repository. | ||
- *hg diff* | ||
- Run from the repository folder. Compares the current state of the | ||
files with that on the last commit and shows any differences. | ||
- *hg qnew [patchname]* | ||
- Creates a patch (written to firefox/.hg/patches) that will allow | ||
any local changes to be applied to another clone of this codebase | ||
(or different branches of the same one). | ||
- *./mach mercurial-setup* | ||
- Set up Mercurial to work with mach. | ||
- *hg log -l 10* | ||
- list the last 10 commits. To go back further, just specify a different number | ||
* Tasks | ||
|
||
** Set up Mercurial for Mozilla Patch Creation | ||
- Out of the box mercurial isn't set up to work with the mozilla build | ||
system (/mach/). | ||
-- Some of this has already been done, but you will need to open the *.hgrc* | ||
file (this is a hidden file, you won't see it until you open it with an | ||
editor, but it's in your home folder. | ||
- In .hgrc, first edit the username entry so it matches the phabricator username | ||
you create. You'll have to go online and do this first. | ||
- You won't get a key to do passwordless commits, only long time contributors | ||
get those, so each time you do one, you'll have to log in. | ||
- Then add | ||
#+BEGIN_SRC bash | ||
mq = | ||
#+END_SRC | ||
to the [extensions] section | ||
- This should be your *.hgrc* file set up. | ||
** List all the tags | ||
- *hg tags* | ||
- Evidence this by piping the output to a text file, then include that | ||
in your submission for this worksheet. | ||
|
||
** compile the source code | ||
- This will take quite a while, so use the *&* again in case you have | ||
to log out before the build finishes. | ||
- *NOTE* If you are using the VM, as mentioned above and in lectures, you will need to update | ||
th source code before compiling by using the command *hg update* | ||
#+BEGIN_SRC bash | ||
./mach build & | ||
#+END_SRC | ||
- Once it has built, you can launch it with this command: | ||
#+BEGIN_SRC bash | ||
./mach run | ||
#+END_SRC | ||
- Screenshot the running program and include it in your submission. | ||
** edit a cpp file | ||
- Select any cpp file and make a change to it. This change can be | ||
trivial, it only needs to show up in a diff. | ||
** Create a patch | ||
- Diff the codebase, if there are changes shown, create a patch. This | ||
patch then goes in your submission for this worksheet. | ||
- You will need to get your evidence out of the virtual machine. Use git to achieve this. | ||
|
||
** restore the codebase | ||
- Use the command listed above in the commands section that will remove any local edits so you | ||
can begin your proper bug fixing work. | ||
** inspecting the commit history | ||
- List the last ten commits | ||
* Worksheet evidence. | ||
- Put the tags listing, the list of the last ten commits and your | ||
Patch, in a *single* document. | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Binary file not shown.
Oops, something went wrong.